Skip to content

Specify where to find draft changelog in release process doc #910

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.

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

Merged
Changes from all commits
Commits
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
7 changes: 5 additions & 2 deletions docs/release-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,11 @@ To create a new release, follow these steps:
[conformance tests Makefile](../conformance/Makefile) to `X.Y.Z`.
7. Update the [README](../README.md) to include information about the release.
8. Update the [changelog](../CHANGELOG.md). The changelog includes only important (from the user perspective)
changes to NKG. This is in contrast with the autogenerated full changelog, which is created in the next step. Use
the previous changelog entries for formatting and content guidance.
changes to NKG. This is in contrast with the autogenerated full changelog, which is created in the next 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/nginxinc/nginx-kubernetes-gateway/releases) after the release branch is
created. Use the previous changelog entries for formatting and content guidance.
7. Create and push the release tag in the format `vX.Y.Z`. As a result, the CI/CD pipeline will:
- Build NKG container images with the release tag `X.Y.Z` and push it to the registry.
- Package and publish the Helm chart to the registry.
Expand Down