-
Notifications
You must be signed in to change notification settings - Fork 104
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
Added release procedure documentation: docs/release-process.md. Co-authored-by: Matthew Yacobucci <[email protected]> (cherry picked from commit f6976c4) Co-authored-by: Pamme <[email protected]>
- Loading branch information
1 parent
c08db6e
commit d0d604b
Showing
1 changed file
with
27 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |