Skip to content

Commit

Permalink
Added release process to README.md. (#191)
Browse files Browse the repository at this point in the history
Added release procedure documentation: docs/release-process.md.

Co-authored-by: Matthew Yacobucci <m.yacobucci@f5.com>
  • Loading branch information
pammecrandall and f5yacobucci authored Aug 22, 2022
1 parent 76f9a81 commit f6976c4
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions docs/release-process.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Release Process for NGINX Kubernetes Gateway

NGINX Kubernetes Gateway uses semantic versioning for its releases. For more information see https://semver.org.

Warning: Major version zero (0.y.z) is reserved for development, anything MAY change at any time. The public API is not stable.

### Steps to create a release.

1. Create a release branch from main, use the naming format: release-MAJOR.MINOR.

2. Create a release candidate tag, use the naming format: vMAJOR.MINOR.PATCH-rc.N (N must start from 1 and monotonically increase with each release candidate).

3. Test the release candidate.

If the tests fail

- Create a fix for the error.

- Open a PR with the fix against the main branch.

- Once approved and merged, cherry-pick the commit into the release branch.

- Create a new release candidate tag, increment the release candidate number by 1.

4. Iterate over the process in step 3 until all the tests pass on the release candidate tag then create the final release tag from the release branch in the format vMAJOR.MINOR.PATCH. The docker image will automatically be pushed to ghcr.io/nginxinc/nginx-kubernetes-gateway:MAJOR.MINOR.PATCH with the release tag as the docker tag.

5. Update the changelog with the changes added in the release. They can be found in the github release notes that was generated from the release branch.

0 comments on commit f6976c4

Please sign in to comment.