Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add netlify note to release process doc #1350

Merged
merged 6 commits into from
Dec 8, 2023
Merged

Add netlify note to release process doc #1350

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
862cddb
Add netlify note to release process doc
sjberman Dec 7, 2023
e307768
Fix phrasing
sjberman Dec 8, 2023
06bf786
ensure pipeline passes
sjberman Dec 8, 2023
c59a9c7
ensure docs look good
sjberman Dec 8, 2023
8aae6d5
Merge branch 'main' into chore/release-process-netlify
sjberman Dec 8, 2023
619185f
Merge branch 'main' into chore/release-process-netlify
sjberman Dec 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/developer/release-process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ To create a new release, follow these steps:
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.
6. If a compatibility issue is found, add a note to the release notes explaining that the previous version is not supported.
7. Create a release branch following the `release-X.Y` naming convention.
8. Prepare and merge a PR into the release branch to update the repo files for the release:
8. 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 `TAG` in the
Expand Down Expand Up @@ -61,10 +61,11 @@ To create a new release, follow these steps:
10. 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). Also update any installation instructions to ensure
that the supported Gateway API and NGF versions are correct. Specifically, helm README and `site/content/includes/installation/install-gateway-api-resources.md`.
11. Close the issue created in Step 1.
12. Ensure that the [associated milestone](https://github.com/nginxinc/nginx-gateway-fabric/milestones) is closed.
13. Verify that published artifacts in the release can be installed properly.
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).
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).
12. Close the issue created in Step 1.
13. Ensure that the [associated milestone](https://github.com/nginxinc/nginx-gateway-fabric/milestones) is closed.
14. Verify that published artifacts in the release can be installed properly.
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).
- Create a fork of the repository
- Name the file `nginxinc-nginx-gateway-fabric.yaml` and set `gatewayAPIVersion` in the file to the
supported version by NGF. Also update the site source if necessary (see following example).
Expand Down
Loading