The Network Policy API project is has the following two main release components:
- Kubernetes Custom Resource Definitions (CRDs)
- Corresponding Go bindings for the API (
sigs.k8s.io/network-policy-api
Go package)
This repository is the home for both of the above components.
The versioning strategy for this project is covered in detail in the release documentation.
Adapted with 💙 from the gateway api project release documentation
To simplify release notes generation, we recommend using the Kubernetes release notes generator:
go install k8s.io/release/cmd/release-notes@latest
export GITHUB_TOKEN=your_token_here
release-notes --start-sha EXAMPLE_COMMIT --end-sha EXAMPLE_COMMIT --branch main --repo network-policy-api --org kubernetes-sigs
This output will likely need to be reorganized and cleaned up a bit, but it
provides a good starting point. Once you're satisfied with the changelog, create
a PR. This must go through the regular PR review process and get merged into the
main
branch. Approval of the PR indicates community consensus for a new
release.
The following steps must be done by one of the network-policy API maintainers:
For a PATCH release:
- Create a new branch in your fork named something like
<githubuser>/release-x.x.x
. Use the new branch in the upcoming steps. - Use
git
to cherry-pick all relevant PRs into your branch. - Update
pkg/generator/main.go
with the new semver tag and any updates to the API review URL. - Create a pull request of the
<githubuser>/release-x.x.x
branch into therelease-x.x
branch upstream (which should already exist since this is a patch release). Add a hold on this PR waiting for at least one maintainer/codeowner to provide algtm
. - Verify the CI tests pass and merge the PR into
release-x.x
. - Create a tag using the
HEAD
of therelease-x.x
branch. This can be done using thegit
CLI or Github's release page. - Run the
make build-install-yaml
command which will generate install files in therelease/
directory. Attach these files to the Github release. - Update the
README.md
andsite-src/guides/index.md
files to point links and examples to the new release.
For a MAJOR or MINOR release:
- Cut a
release-major.minor
branch that we can tag things in as needed. - Check out the
release-major.minor
release branch locally. - Update
pkg/generator/main.go
with the new semver tag and any updates to the API review URL. - Verify the CI tests pass before continuing.
- Create a tag using the
HEAD
of therelease-x.x
branch. This can be done using thegit
CLI or Github's release page. - Run the
make build-install-yaml
command which will generate install files in therelease/
directory. Attach these files to the Github release. - Update the
README.md
andsite-src/guides/index.md
files to point links and examples to the new release.
For an RC release:
- Update
pkg/generator/main.go
with the new semver tag and any updates to the API review URL. - Include the changelog update in this PR.
- Merge the update PR.
- Tag the release using the commit on
main
where the changelog update merged. This can be done using thegit
CLI or Github's release page. - Run the
make build-install-yaml
command which will generate install files in therelease/
directory. - Attach these files to the Github release.