Skip to content

Commit 3d38822

Browse files
authored
Add netlify note to release process doc (#1350)
Ensure that we are updating the Netlify production branch when releasing.
1 parent b77d74b commit 3d38822

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

docs/developer/release-process.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ To create a new release, follow these steps:
3333
5. If the supported Gateway API minor version has changed since the last release, test NGINX Gateway Fabric with the previous version of the Gateway API CRDs.
3434
6. If a compatibility issue is found, add a note to the release notes explaining that the previous version is not supported.
3535
7. Create a release branch following the `release-X.Y` naming convention.
36-
8. Prepare and merge a PR into the release branch to update the repo files for the release:
36+
8. Prepare and merge a PR into the **release branch** to update the repo files for the release:
3737
1. Update the Helm [Chart.yaml](/deploy/helm-chart/Chart.yaml): the `appVersion` to `X.Y.Z`, the icon and source
3838
URLs to point at `vX.Y.Z`, and bump the `version`.
3939
2. Adjust the `VERSION` variable in the [Makefile](/Makefile) and the `TAG` in the
@@ -61,10 +61,11 @@ To create a new release, follow these steps:
6161
10. Prepare and merge a PR into the main branch to update the [README](/README.md) to include the information about
6262
the latest release and also the [changelog](/CHANGELOG.md). Also update any installation instructions to ensure
6363
that the supported Gateway API and NGF versions are correct. Specifically, helm README and `site/content/includes/installation/install-gateway-api-resources.md`.
64-
11. Close the issue created in Step 1.
65-
12. Ensure that the [associated milestone](https://github.com/nginxinc/nginx-gateway-fabric/milestones) is closed.
66-
13. Verify that published artifacts in the release can be installed properly.
67-
14. 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).
64+
11. Update the production branch to the latest release branch in [Netlify](https://app.netlify.com/sites/nginx-gateway-fabric/configuration/deploys#branches-and-deploy-contexts). If it's your first time, log in using Gitlab SSO and ask the docs team for permission to access the NGF project. Ensure that once the branch is updated, the deployment pipeline in Netlify passes and that the published docs look good (no obvious errors or issues).
65+
12. Close the issue created in Step 1.
66+
13. Ensure that the [associated milestone](https://github.com/nginxinc/nginx-gateway-fabric/milestones) is closed.
67+
14. Verify that published artifacts in the release can be installed properly.
68+
15. 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).
6869
- Create a fork of the repository
6970
- Name the file `nginxinc-nginx-gateway-fabric.yaml` and set `gatewayAPIVersion` in the file to the
7071
supported version by NGF. Also update the site source if necessary (see following example).

0 commit comments

Comments
 (0)