Skip to content

Commit 554b330

Browse files
committed
Update release process doc
Fixed linked to getting started doc. For some reason this doc wasn't updated last time we ran the release docs PR, so keeping as a manual step for now. Also fixed the patch release process.
1 parent 1744837 commit 554b330

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/developer/release-process.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ To create a new release, follow these steps:
4444
1. Kick off the [longevity tests](https://github.com/nginxinc/nginx-gateway-fabric/blob/main/tests/README.md#longevity-testing) for both OSS and Plus. You'll need to create two clusters and VMs for this. Before running, update your `vars.env` file with the proper image tag and prefixes. NGF and nginx images will be available from `ghcr.io`, and nginx plus will be available in GCP (`us-docker.pkg.dev/<GCP_PROJECT_ID>/nginx-gateway-fabric/nginx-plus`). These tests need to run for 4 days before releasing. The results should be committed to the main branch and then cherry-picked to the release branch.
4545
2. Kick off the [NFR workflow](https://github.com/nginxinc/nginx-gateway-fabric/actions/workflows/nfr.yml) in the browser. For `image_tag`, use `release-X.X-rc`, and for `version`, use the upcoming `X.Y.Z` NGF version. This will run all of the NFR tests which are automated and open a PR with the results files when it is complete. Review this PR and make any necessary changes before merging. Once merged, be sure to cherry-pick the commit to the main branch as well (the original PR targets the release branch).
4646
5. Run the [Release PR](https://github.com/nginxinc/nginx-gateway-fabric/actions/workflows/release-pr.yml) workflow to update the repo files for the release. Then there are a few manual steps to complete:
47-
1. Update the tag of NGF container images used in the [provisioner manifest](/tests/conformance/provisioner/provisioner.yaml) and [running-on-kind guide](/site/content/installation/running-on-kind.md#set-up-a-nodeport).
47+
1. Update the version tag used in the [provisioner manifest](/tests/conformance/provisioner/provisioner.yaml) and [getting started guide](/site/content/get-started).
4848
2. Update the [README](/README.md) to include information about the release.
4949
3. Update the [changelog](/CHANGELOG.md). There is going to be a new blank section generated by the automation that needs to be adjusted accordingly.
5050
- At the top there will be a list of all PRs that are labeled with `release-notes`.
@@ -91,4 +91,4 @@ To create a new release, follow these steps:
9191
branch.
9292
4. Test the release branch for release-readiness.
9393
5. If a problem is found, return to Step 2.
94-
6. Follow Steps 6-9 from the [Major or Minor Release](#major-or-minor-release) section.
94+
6. Follow Steps 5-7 from the [Major or Minor Release](#major-or-minor-release) section.

0 commit comments

Comments
 (0)