Skip to content

Commit 48c7813

Browse files
committed
Update CHANGELOG and README for release
1 parent e7c8a21 commit 48c7813

File tree

3 files changed

+34
-5
lines changed

3 files changed

+34
-5
lines changed

CHANGELOG.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,28 @@ This document includes a curated changelog for each release. We also publish a c
44
a [GitHub release](https://github.com/nginxinc/nginx-kubernetes-gateway/releases), which, by contrast, is auto-generated
55
and includes links to all PRs that went into the release.
66

7+
## Release 0.6.0
8+
9+
*August 31, 2023*
10+
11+
This release adds a Helm chart, dynamic control plane logging, Prometheus metrics, and in-depth guides for various use cases.
12+
13+
FEATURES:
14+
15+
- Helm chart. [PR-840](https://github.com/nginxinc/nginx-kubernetes-gateway/pull/840)
16+
- Use custom nginx container. [PR-934](https://github.com/nginxinc/nginx-kubernetes-gateway/pull/934)
17+
- Support dynamic control plane logging. [PR-943](https://github.com/nginxinc/nginx-kubernetes-gateway/pull/943)
18+
- Support websocket connections. [PR-962](https://github.com/nginxinc/nginx-kubernetes-gateway/pull/962)
19+
- Support Prometheus metrics. [PR-999](https://github.com/nginxinc/nginx-kubernetes-gateway/pull/999)
20+
21+
BUG FIXES:
22+
23+
- Ensure NGINX Kubernetes Gateway has least privileges. [PR-1004](https://github.com/nginxinc/nginx-kubernetes-gateway/pull/1004)
24+
25+
DOCUMENTATION:
26+
27+
- Use case guides: https://github.com/nginxinc/nginx-kubernetes-gateway/tree/v0.6.0/docs/guides
28+
729
## Release 0.5.0
830

931
*July 17, 2023*

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Learn about our [design principles](/docs/developer/design-principles.md) and [a
3232
We publish NGINX Kubernetes Gateway releases on GitHub. See
3333
our [releases page](https://github.com/nginxinc/nginx-kubernetes-gateway/releases).
3434

35-
The latest release is [0.5.0](https://github.com/nginxinc/nginx-kubernetes-gateway/releases/tag/v0.5.0).
35+
The latest release is [0.6.0](https://github.com/nginxinc/nginx-kubernetes-gateway/releases/tag/v0.6.0).
3636

3737
The edge version is useful for experimenting with new features that are not yet published in a release. To use, choose
3838
the *edge* version built from the [latest commit](https://github.com/nginxinc/nginx-kubernetes-gateway/commits/main)
@@ -51,7 +51,7 @@ to the correct versions:
5151

5252
| Version | Description | Image | Installation Manifests | Documentation and Examples |
5353
|----------------|------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
54-
| Latest release | For experimental use | Use the 0.5.0 image from [GitHub](https://github.com/nginxinc/nginx-kubernetes-gateway/pkgs/container/nginx-kubernetes-gateway) | [Manifests](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/v0.5.0/deploy). | [Documentation](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/v0.5.0/docs). [Examples](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/v0.5.0/examples). |
54+
| Latest release | For experimental use | Use the 0.6.0 image from [GitHub](https://github.com/nginxinc/nginx-kubernetes-gateway/pkgs/container/nginx-kubernetes-gateway) | [Manifests](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/v0.6.0/deploy). | [Documentation](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/v0.6.0/docs). [Examples](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/v0.6.0/examples). |
5555
| Edge | For experimental use and latest features | Use the edge image from [GitHub](https://github.com/nginxinc/nginx-kubernetes-gateway/pkgs/container/nginx-kubernetes-gateway) | [Manifests](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/main/deploy). | [Documentation](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/main/docs). [Examples](https://github.com/nginxinc/nginx-kubernetes-gateway/tree/main/examples). |
5656

5757
## Technical Specifications
@@ -60,7 +60,8 @@ The following table lists the software versions NGINX Kubernetes Gateway support
6060

6161
| NGINX Kubernetes Gateway | Gateway API | Kubernetes | NGINX OSS |
6262
|--------------------------|-------------|------------|-----------|
63-
| Edge | 0.8.0 | 1.22+ | 1.25.2 |
63+
| Edge | 0.8.0 | 1.23+ | 1.25.2 |
64+
| 0.6.0 | 0.8.0 | 1.23+ | 1.25.2 |
6465
| 0.5.0 | 0.7.1 | 1.21+ | 1.25.x * |
6566
| 0.4.0 | 0.7.1 | 1.21+ | 1.25.x * |
6667
| 0.3.0 | 0.6.2 | 1.21+ | 1.23.x * |

docs/release-process.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@ To create a new release, follow these steps:
3535
1. Update the Helm [Chart.yaml](../deploy/helm-chart/Chart.yaml): the `appVersion` to `X.Y.Z`, the icon and source
3636
URLs to point at `vX.Y.Z`, and bump the `version`.
3737
2. Update the Helm [README](../deploy/helm-chart/README.md) `--version` flags in the helm commands to use the stable
38-
`appVersion` from the previous step.
38+
`version` from the previous step.
3939
3. Adjust the `VERSION` variable in the [Makefile](../Makefile) and the `NKG_TAG` in the
4040
[conformance tests Makefile](../conformance/Makefile) to `X.Y.Z`.
4141
4. Update the tag of NKG container images used in the Helm [values.yaml](../deploy/helm-chart/values.yaml) file, the
42-
[provisioner manifest](../conformance/provisioner/provisioner.yaml)), and all docs to `X.Y.Z`.
42+
[provisioner manifest](../conformance/provisioner/provisioner.yaml), and all docs to `X.Y.Z`.
4343
5. Ensure that the `imagePullPolicy` is `IfNotPresent` in the Helm [values.yaml](../deploy/helm-chart/values.yaml)
4444
file.
4545
6. Generate the installation manifests by running `make generate-manifests`.
@@ -59,6 +59,12 @@ To create a new release, follow these steps:
5959
8. Prepare and merge a PR into the main branch to update the [README](../README.md) to include the information about the
6060
latest release and also the [changelog](../CHANGELOG.md).
6161
9. Close the issue created in Step 1.
62+
10. Submit the `conformance-profile.yaml` artifact from the release to the [Gateway API repo](https://github.com/kubernetes-sigs/gateway-api/tree/main/conformance/reports).
63+
- Create a fork of the repository
64+
- Name the file `nginxinc-nginx-kubernetes-gateway.yaml` and set `gatewayAPIVersion` in the file to the
65+
supported version by NKG. Also update the site source if necessary (see following example).
66+
- Open a PR. [Example](https://github.com/kubernetes-sigs/gateway-api/pull/2368)
67+
If it's your first time submitting a PR, you will need to sign a CLA using F5, Inc. as the organization.
6268

6369
### Patch Release
6470

0 commit comments

Comments
 (0)