diff --git a/docs/developer/release-process.md b/docs/developer/release-process.md index 0481092860..d215c10556 100644 --- a/docs/developer/release-process.md +++ b/docs/developer/release-process.md @@ -42,9 +42,9 @@ To create a new release, follow these steps: 3. Create a release branch following the `release-X.Y` naming convention. 4. Once the release branch pipeline completes, run tests using the `release-X.X-rc` images that are pushed to Github (for example, `release-1.3-rc`). 1. Kick off the [longevity tests](https://github.com/nginx/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//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. - 2. Kick off the [NFR workflow](https://github.com/nginx/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). + 2. Kick off the [NFR workflow](https://github.com/nginx/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. Run the workflow on the new release branch. 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). 5. Run the [Release PR](https://github.com/nginx/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: - 1. Update the version tag used in the [provisioner manifest](/tests/conformance/provisioner/provisioner.yaml) and [getting started guide](/site/content/get-started). + 1. Update the version tag used in the [provisioner manifest](/tests/conformance/provisioner/provisioner.yaml) and [getting started guide](/site/content/get-started.md). 2. Update the [README](/README.md) to include information about the release. 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. - At the top there will be a list of all PRs that are labeled with `release-notes`. @@ -53,9 +53,9 @@ To create a new release, follow these steps: 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 the [GitHub releases](https://github.com/nginx/nginx-gateway-fabric/releases) after the release branch is - created. + created. If included, use the Release Notes specified in a PR. - If the supported Gateway API minor version has changed since the last release, add a note to the release notes explaining if the previous version is no longer supported. -6. Create and push the release tag in the format `vX.Y.Z`. As a result, the CI/CD pipeline will: +6. Ensure you are on the latest version of the release branch and are up-to-date on all commits, then create and push the release tag in the format `vX.Y.Z`. As a result, the CI/CD pipeline will: - Build NGF, NGINX and NGINX Plus container images with the release tag `X.Y.Z` and push them to the registries. - Package and publish the Helm chart to the registry. - Create a GitHub release with an autogenerated changelog and attached release artifacts. diff --git a/tests/README.md b/tests/README.md index bd9a5f8061..1db86ebc3b 100644 --- a/tests/README.md +++ b/tests/README.md @@ -318,7 +318,7 @@ make nfr-test This test is run on its own (and also not in a pipeline) due to its long-running nature. It will run for 4 days before the tester must collect the results and complete the test. -To start the longevity test, set up your VM (`create-and-setup-vm`) and run +To start the longevity test, set up your VM (`create-and-setup-vm`), router (`create-gke-router`), and run ```makefile make start-longevity-test