This doc covers the release process for the functions in the krm-functions-catalog repo.
- Checking the CI status of the main branch. If the CI is failing on the main, we need to fix it before doing a release.
- Go to the releases pages in your browser.
- Click
Draft a new releaseto create a new release for a function. The tag version format should befunctions/go/{function-name}/{semver}. e.g.functions/go/set-namespace/v0.1.0. The release name should be{function-name} {semver}(see VERSIONING.md for the semver strategy). The release notes for this function should be in the body. - Click
Publish releasebutton. - Verify the new functions are released in ghcr.io/kptdev/krm-functions-catalog/{function-name}/{semver} or, if using the GitHub based CD flow, check the relevant GitHub packages section
- Send an announcement on the kpt slack channel
After creating a release, open a new PR to update/create the docs:
- Ensure you are on the
mainbranch and it is up to date - Create a new branch for the doc update:
git checkout -b docs/set-namespace-v0.4
- Run the doc generation for the released function:
make generate-docs FN=set-namespace
- Preview the docs locally (see documentation/README.md):
make serve-docs
- Commit the generated docs and submit a PR
See make help for additional targets.