From b83a8123afefe7b07af3c8764416529ebbbfaa44 Mon Sep 17 00:00:00 2001 From: Saylor Berman Date: Mon, 23 Oct 2023 10:33:45 -0600 Subject: [PATCH] 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. --- deploy/helm-chart/Chart.yaml | 2 +- docs/developer/release-process.md | 24 ++++++++++++------------ 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/deploy/helm-chart/Chart.yaml b/deploy/helm-chart/Chart.yaml index 5887d8e86..2bdea7f01 100644 --- a/deploy/helm-chart/Chart.yaml +++ b/deploy/helm-chart/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 name: nginx-gateway-fabric description: NGINX Gateway Fabric type: application -version: 0.1.0 +version: 1.0.0 appVersion: "edge" home: https://github.com/nginxinc/nginx-gateway-fabric icon: https://raw.githubusercontent.com/nginxinc/nginx-gateway-fabric/tree/main/deploy/helm-chart/chart-icon.png diff --git a/docs/developer/release-process.md b/docs/developer/release-process.md index 6d099eeb0..15287b3f2 100644 --- a/docs/developer/release-process.md +++ b/docs/developer/release-process.md @@ -28,23 +28,23 @@ To create a new release, follow these steps: format `Release X.Y.Z`. 2. Stop merging any new work into the main branch. 3. Test the main branch for release-readiness. For that, use the `edge` containers, which are built from the main - branch. + branch, and the [example applications](/examples). 4. If a problem is found, prepare a fix PR, merge it into the main branch and return to the previous step. 5. Create a release branch with a name that follows the `release-X.Y` format. 6. Prepare and merge a PR into the release branch to update the repo files for the release: - 1. Update the Helm [Chart.yaml](../deploy/helm-chart/Chart.yaml): the `appVersion` to `X.Y.Z`, the icon and source - URLs to point at `vX.Y.Z`, and bump the `version`. - 2. Adjust the `VERSION` variable in the [Makefile](../Makefile) and the `NGF_TAG` in the - [conformance tests Makefile](../conformance/Makefile) to `X.Y.Z`. - 3. Update the tag of NGF container images used in the Helm [values.yaml](../deploy/helm-chart/values.yaml) file, the - [provisioner manifest](../conformance/provisioner/provisioner.yaml), and all docs to `X.Y.Z`. - 4. Ensure that the `imagePullPolicy` is `IfNotPresent` in the Helm [values.yaml](../deploy/helm-chart/values.yaml) + 1. Update the Helm [Chart.yaml](/deploy/helm-chart/Chart.yaml): the `appVersion` to `X.Y.Z`, the icon and source + URLs to point at `vX.Y.Z`. + 2. Adjust the `VERSION` variable in the [Makefile](/Makefile) and the `NGF_TAG` in the + [conformance tests Makefile](/conformance/Makefile) to `X.Y.Z`. + 3. Update the tag of NGF container images used in the Helm [values.yaml](/deploy/helm-chart/values.yaml) file, the + [provisioner manifest](/conformance/provisioner/provisioner.yaml), and all docs to `X.Y.Z`. + 4. Ensure that the `imagePullPolicy` is `IfNotPresent` in the Helm [values.yaml](/deploy/helm-chart/values.yaml) file. 5. Generate the installation manifests by running `make generate-manifests`. 6. Modify any `git clone` instructions to use `vX.Y.Z` tag. 7. Modify any docs links that refer to `main` to instead refer to `vX.Y.Z`. - 8. Update the [README](../README.md) to include information about the release. - 9. Update the [changelog](../CHANGELOG.md). The changelog includes only important (from the user perspective) + 8. Update the [README](/README.md) to include information about the release. + 9. Update the [changelog](/CHANGELOG.md). The changelog includes only important (from the user perspective) changes to NGF. This is in contrast with the autogenerated full changelog, which is created in the next step. As a starting point, copy the important features, bug fixes, and dependencies from the autogenerated draft of the full changelog. This draft can be found under @@ -54,8 +54,8 @@ To create a new release, follow these steps: - Build NGF container images with the release tag `X.Y.Z` and push it to the registry. - Package and publish the Helm chart to the registry. - Create a GitHub release with an autogenerated changelog and attached release artifacts. -8. Prepare and merge a PR into the main branch to update the [README](../README.md) to include the information about the - latest release and also the [changelog](../CHANGELOG.md). +8. Prepare and merge a PR into the main branch to update the [README](/README.md) to include the information about the + latest release and also the [changelog](/CHANGELOG.md). 9. Close the issue created in Step 1. 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). - Create a fork of the repository