Skip to content

Commit bdbd597

Browse files
committed
Release 0.1.0-1
1 parent e9ed4ae commit bdbd597

File tree

3 files changed

+42
-6
lines changed

3 files changed

+42
-6
lines changed

CHANGELOG.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
99

1010
### Added
1111

12+
### Changed
13+
14+
### Fixed
15+
16+
### Removed
17+
18+
### Deprecated
19+
20+
### Security
21+
22+
## [0.1.0-1] - 2025-01-06
23+
24+
### Added
25+
1226
- Initial implementation of plugin
1327
- Added GitHub action build for linting and unit testing
1428
- Added function to handle unexpected errors and exit the plugin
@@ -23,7 +37,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2337
- Extracted `kong.response.exit(500, "An unexpected error occurred")` to its own function
2438
- Extracted the code inside the `repeat ... until` loop into its own function
2539
- Modified `make_fga_request` to return a boolean indicating allow/deny
26-
- For local development, a kong-*dev-0.rockspec file is used to install the plugin. This helps segregate
40+
- For local development, a kong-\*dev-0.rockspec file is used to install the plugin. This helps segregate
2741
the testing from the release process.
2842
- Changed the rockspec license to MIT.
2943

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ The goal of this plugin is to integrate Kong with OpenFGA for fine-grained autho
44

55
## Installation
66

7-
Install the plugin using `luarocks`. @TODO: The package is not yet hosted on LuaRocks or as an release asset on GitHub.
7+
Install the plugin using `luarocks`.
88

99
```sh
10-
luarocks install kong-plugin-kong-authz-openfga-0.1.0-1.all.rock
10+
luarocks install kong-plugin-kong-authz-openfga
1111
```
1212

1313
## Enable it in Kong
@@ -254,7 +254,7 @@ make clean
254254

255255
## Run CI lint, unit and integration tests
256256

257-
@TODO: Add build, test, and deploy pipeline (GitHub Actions) to the project
257+
The project integrates with GitHub Actions for CI. The CI pipeline runs the lint, unit and integration tests.
258258

259259
## Test against a different Kong version
260260

@@ -280,7 +280,7 @@ The project bundles a mock server for OpenFGA.
280280

281281
### CI container image
282282

283-
@TODO: TBD
283+
The CI container image can be found under \_build/images/kong-tooling/Dockerfile. The image is based on the official Kong image and contains all the necessary tools to run the lint, unit and integration tests.
284284

285285
## Recommended Visual Studio Code extensions
286286

@@ -301,7 +301,7 @@ The project bundles a mock server for OpenFGA.
301301
7. Commit the changes, create a tag and push changes and tag to the remote repository
302302
1. `git add plugin.properties *.rockspec README.md kong/plugins/*/handler.lua CHANGELOG.md`
303303
2. `git commit -m "Release x.y.z-r"`
304-
3. `git tag x.y.z-r`
304+
3. `git tag vx.y.z-r`
305305
4. `git push`
306306
5. `git push --tags`
307307
8. @TODO: Add step to perform a release in GitHub
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
package = "kong-plugin-kong-authz-openfga"
2+
version = "0.1.0-1"
3+
source = {
4+
url = "git+https://github.com/dol/kong-authz-openfga.git",
5+
tag = "v0.1.0-1"
6+
}
7+
description = {
8+
summary = "Kong plugin for kong-authz-openfga integration",
9+
homepage = "https://github.com/dol/kong-authz-openfga",
10+
license = "MIT"
11+
}
12+
dependencies = {
13+
"lua ~> 5.1"
14+
}
15+
build = {
16+
type = "builtin",
17+
modules = {
18+
["kong.plugins.kong-authz-openfga.access"] = "kong/plugins/kong-authz-openfga/access.lua",
19+
["kong.plugins.kong-authz-openfga.handler"] = "kong/plugins/kong-authz-openfga/handler.lua",
20+
["kong.plugins.kong-authz-openfga.schema"] = "kong/plugins/kong-authz-openfga/schema.lua"
21+
}
22+
}

0 commit comments

Comments
 (0)