Skip to content

Latest commit

 

History

History
42 lines (35 loc) · 1.83 KB

File metadata and controls

42 lines (35 loc) · 1.83 KB

Release Process

This doc covers the release process for the functions in the krm-functions-catalog repo.

  1. 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.
  2. Go to the releases pages in your browser.
  3. Click Draft a new release to create a new release for a function. The tag version format should be functions/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.
  4. Click Publish release button.
  5. 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
  6. Send an announcement on the kpt slack channel

Updating or creating function docs

After creating a release, open a new PR to update/create the docs:

  1. Ensure you are on the main branch and it is up to date
  2. Create a new branch for the doc update:
    git checkout -b docs/set-namespace-v0.4
  3. Run the doc generation for the released function:
    make generate-docs FN=set-namespace
  4. Preview the docs locally (see documentation/README.md):
    make serve-docs
  5. Commit the generated docs and submit a PR

See make help for additional targets.