randmonkey / kubernetes-ingress-controller Goto Github PK

Release Type

No response

Release Version

No response

Release Tests

No response

Release Branch

s

Release Pull Request

s

Release documents

No response

Manual Docker image build

No response

Release Type

minor release

Relase Version

2.4.0

For all releases Github Workflow Test Matrix Checkup

• check the testing workflow (.github/workflows/test.yaml) and ensure that all matrix versions (.github/workflows/e2e.yaml and .github/workflows/release.yaml) are up to date for various component releases. If there have been any new releases (major, minor or patch) of those components since the latest version seen in that configuration make sure the new versions get added before proceeding with the release. Remove any versions that are no longer supported by the environment provider.
• Kubernetes
• Istio

For all releases Create Release Branch

• ensure that you have up to date copy of main: git fetch --all
• create the release branch for the version (e.g. release/1.3.1): git branch -m release/x.y.z
• Make any final adjustments to CHANGELOG.md. Double-check that dates are correct, that link anchors point to the correct header, and that you've included a link to the Github compare link at the end.
• retrieve the latest license report from FOSSA and save it to LICENSES
• ensure base manifest versions use the new version (config/image/enterprise/kustomization.yaml and config/image/oss/kustomization.yaml) and update manifest files: make manifests
• push the branch up to the remote: git push --set-upstream origin release/x.y.z

For all releases Create a Release Pull Request

• Check the latest nightly job to confirm that E2E is succeeding. If you are backporting features into a non-main branch, run a targeted E2E job against that branch.
• Open a PR from your branch to main.
• Once the PR is merged, initiate a release job. Your tag must use vX.Y.Z format. Set latest to true if this will be the latest release.
• CI will validate the requested version, build and push an image, and run tests against the image before finally creating a tag and publishing a release. If tests fail, CI will push the image but not the tag or release. Investigate the failure, correct it as needed, and start a new release job.

For major/minor releases only Update Release documents

• Create a new branch in the documentation site repo.
• Copy app/kubernetes-ingress-controller/OLD_VERSION to app/kubernetes-ingress-controller/NEW_VERSION.
• Update articles in the new version as needed.
• Update references/version-compatibility.md to include the new versions (make sure you capture any new Kubernetes/Istio versions that have been tested)
• Copy app/_data/docs_nav_kic_OLDVERSION.yml to app/_data/docs_nav_kic_NEWVERSION.yml. Add entries for any new articles.
• Add a section to app/_data/kong_versions.yml for your version.
• Open a PR from your branch.

Release Troubleshooting

If the "Build and push development images" Github action is not appropriate for your release, or is not operating properly, you can build and push Docker images manually

Manual Docker image build

• Check out your release tag.
• Run make container. Note that you can set the TAG environment variable if you need to override the current tag in Makefile.
• Add additional tags for your container (e.g. docker tag kong/kubernetes-ingress-controller:1.2.0-alpine kong/kubernetes-ingress-controller:1.2.0; docker tag kong/kubernetes-ingress-controller:1.2.0-alpine kong/kubernetes-ingress-controller:1.2)
• Create a temporary token for the kongbot user (see 1Password) and log in using it.
• Push each of your tags (e.g. docker push kong/kubernetes-ingress-controller:1.2.0-alpine)