Skip to content

Commit b83a812

Browse files
authored
Update helm chart to 1.0; fix links (#1179)
Bumping helm chart version to 1.0 before the release. Also added a snippet to the release doc for testing our examples. Fixed broken links in the release doc.
1 parent bb95dea commit b83a812

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

deploy/helm-chart/Chart.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ apiVersion: v2
22
name: nginx-gateway-fabric
33
description: NGINX Gateway Fabric
44
type: application
5-
version: 0.1.0
5+
version: 1.0.0
66
appVersion: "edge"
77
home: https://github.com/nginxinc/nginx-gateway-fabric
88
icon: https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/tree/main/deploy/helm-chart/chart-icon.png

docs/developer/release-process.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -28,23 +28,23 @@ To create a new release, follow these steps:
2828
format `Release X.Y.Z`.
2929
2. Stop merging any new work into the main branch.
3030
3. Test the main branch for release-readiness. For that, use the `edge` containers, which are built from the main
31-
branch.
31+
branch, and the [example applications](/examples).
3232
4. If a problem is found, prepare a fix PR, merge it into the main branch and return to the previous step.
3333
5. Create a release branch with a name that follows the `release-X.Y` format.
3434
6. Prepare and merge a PR into the release branch to update the repo files for the release:
35-
1. Update the Helm [Chart.yaml](../deploy/helm-chart/Chart.yaml): the `appVersion` to `X.Y.Z`, the icon and source
36-
URLs to point at `vX.Y.Z`, and bump the `version`.
37-
2. Adjust the `VERSION` variable in the [Makefile](../Makefile) and the `NGF_TAG` in the
38-
[conformance tests Makefile](../conformance/Makefile) to `X.Y.Z`.
39-
3. Update the tag of NGF container images used in the Helm [values.yaml](../deploy/helm-chart/values.yaml) file, the
40-
[provisioner manifest](../conformance/provisioner/provisioner.yaml), and all docs to `X.Y.Z`.
41-
4. Ensure that the `imagePullPolicy` is `IfNotPresent` in the Helm [values.yaml](../deploy/helm-chart/values.yaml)
35+
1. Update the Helm [Chart.yaml](/deploy/helm-chart/Chart.yaml): the `appVersion` to `X.Y.Z`, the icon and source
36+
URLs to point at `vX.Y.Z`.
37+
2. Adjust the `VERSION` variable in the [Makefile](/Makefile) and the `NGF_TAG` in the
38+
[conformance tests Makefile](/conformance/Makefile) to `X.Y.Z`.
39+
3. Update the tag of NGF container images used in the Helm [values.yaml](/deploy/helm-chart/values.yaml) file, the
40+
[provisioner manifest](/conformance/provisioner/provisioner.yaml), and all docs to `X.Y.Z`.
41+
4. Ensure that the `imagePullPolicy` is `IfNotPresent` in the Helm [values.yaml](/deploy/helm-chart/values.yaml)
4242
file.
4343
5. Generate the installation manifests by running `make generate-manifests`.
4444
6. Modify any `git clone` instructions to use `vX.Y.Z` tag.
4545
7. Modify any docs links that refer to `main` to instead refer to `vX.Y.Z`.
46-
8. Update the [README](../README.md) to include information about the release.
47-
9. Update the [changelog](../CHANGELOG.md). The changelog includes only important (from the user perspective)
46+
8. Update the [README](/README.md) to include information about the release.
47+
9. Update the [changelog](/CHANGELOG.md). The changelog includes only important (from the user perspective)
4848
changes to NGF. This is in contrast with the autogenerated full changelog, which is created in the next step. As
4949
a starting point, copy the important features, bug fixes, and dependencies from the autogenerated draft of the
5050
full changelog. This draft can be found under
@@ -54,8 +54,8 @@ To create a new release, follow these steps:
5454
- Build NGF container images with the release tag `X.Y.Z` and push it to the registry.
5555
- Package and publish the Helm chart to the registry.
5656
- Create a GitHub release with an autogenerated changelog and attached release artifacts.
57-
8. Prepare and merge a PR into the main branch to update the [README](../README.md) to include the information about the
58-
latest release and also the [changelog](../CHANGELOG.md).
57+
8. Prepare and merge a PR into the main branch to update the [README](/README.md) to include the information about the
58+
latest release and also the [changelog](/CHANGELOG.md).
5959
9. Close the issue created in Step 1.
6060
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).
6161
- Create a fork of the repository

0 commit comments

Comments
 (0)