Skip to content

chore: bump version to 0.5.0 #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 11, 2023
Merged

chore: bump version to 0.5.0 #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Added

- Added CLI support to easily manage JWT authentification to the routes. Please refer to the [auth documentation](./docs/auth.md) for more information on usage.
- Added CLI support to easily manage JWT authentification to the routes. Please refer to the [auth documentation](https://serverless-gateway.readthedocs.io/en/latest/auth.html) for more information on usage.

### Changed

- Grouped CLI commands thematically. The gateway infastructure management is now split from the gateway configuration via different CLI command group.

## [0.5.0] - 2023-07-11

### Added

- Documentation is now available on [readthedocs](https://serverless-gateway.readthedocs.io/en/latest/).
- Added utilties to manage custom domains for your gateway. Please refer to the [custom domain documentation](https://serverless-gateway.readthedocs.io/en/latest/domains.html) for more information on usage.
- Kong statsd dashboard will now be automatically imported to your Cockpit when using the `deploy` command.
- Improved CLI experience by adding some more progress feedback.
2 changes: 1 addition & 1 deletion cli/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "scw-gateway"
version = "0.4.0"
version = "0.5.0"
description = "CLI to deploy and manage a self-hosted Kong gateway on Scaleway Serverless Ecosystem"
authors = ["Simon Shillaker <sshillaker@scaleway.com>"]
readme = "README.md"
Expand Down
10 changes: 2 additions & 8 deletions docs/source/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ poetry install

Inside your poetry shell, you can generate the config and launch the integration tests locally:

```
```console
scwgw dev config
make test-int
```
Expand All @@ -45,17 +45,11 @@ The settings for metrics collection can be configured using the following enviro
| `COCKPIT_METRICS_PUSH_URL` | Cockpit push metrics endpoint. <br/>Can be found on the Cockpit console page. | |
| `COCKPIT_METRICS_TOKEN` | Cockpit metrics push token. <br/> Requires the `write_metrics` scope. | |

## Healthchecks

When the gateway is deployed on Scaleway Containers, Knative will perform health checks on the root path `/`. We have defined a route to handle those calls which specifically only match Knative probes `User-Agent` with the regex `~*kube-probe/.+`.

Previously, we did not specifiy a header to match against, which caused issues because in Kong every route matches `/` (routing is _greedy_). Therefore, every route which failed to match against the Gateway would be redirected to the health check and return a `200` HTTP status instead of `404`.

## Releasing

To release a new version of the CLI and gateway, we need to create an push a new tag. To do this:

```
```console
# Bump the version
cd cli
poetry version patch
Expand Down