Skip to content

Latest commit

 

History

History
65 lines (58 loc) · 3.3 KB

RELEASING.md

File metadata and controls

65 lines (58 loc) · 3.3 KB
Raw

Release Process

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

  1. Checking the CI badge status on top of the repo's README page. If the CI is failing on the master, 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/{language}/{function-name}/{semver}. e.g. functions/go/set-namespace/v1.2.3 and functions/ts/kubeval/v2.3.4. The release name should be {funtion-name} {semver}. The release notes for this function should be in the body.
  4. Click Publish release button.
  5. Verify the new functions is released in gcr.io/kpt-fn/{funtion-name}/{semver}
  6. Send an announcement email in the kpt users google group.

Note: For most functions, you can ignore the GitHub action "Run the CD script after tags that look like versions". It is only for functions that have KO build and release setup. Currently only three functions uses ko to release: bind, ensure-name-substring, set-gcp-resource-ids.

Updating function docs

After creating a release, the docs for the function should be updated to reflect the latest patch version. A script has been created to automate this process. The RELEASE_BRANCH branch should already exist in the repo and a tag should be created on the releases pages. RELEASE_BRANCH is in the form of ${FUNCTION_NAME}/v${MAJOR_VERSION}.${MINOR_VERSION}. For example set-namespace/v0.3, kubeval/v0.1, etc.

  1. Setup the release branch Release branch should have existed in the upstream repo in the form of <FUNCTION_NAME>/v<MAJOR>.<MINOR>. Let's take set-namespace/v0.4 as an example. You should replace that to your RELEASE_BRANCH. 
    > export RELEASE_BRANCH=set-namespace/v0.4
  2. Clean up the local branch The release script needs to run in the local . To avoid git ref conflicts, we suggest you delete your local branch OR make it up to date with the remote 
> git branch -D ${RELEASE_BRANCH}
  1. Fetch the upstream repository Your upstream repo should point to the official kpt-functions-catalog. Verify your git remote is set as below
> git remote -v | grep upstream
upstream	git@github.com:GoogleContainerTools/kpt-functions-catalog.git (fetch)
upstream	git@github.com:GoogleContainerTools/kpt-functions-catalog.git (push)
# Fetch the latest upstream repo
> git fetch upstream
  1. Run the doc updating script.
git checkout remotes/upstream/master
RELEASE_BRANCH=${RELEASE_BRANCH} make update-function-docs
  1. Send out a Pull Request. Your local git reference is now pointing to the local RELEASE BRANCH. A new git commit is auto-generated which contains the function document referring to the latest function version in the form of <FUNCTION_NAME>/v<MAJOR>.<MINOR>.<PATCH> You should be ready to submit the Pull Request against the upstream <RELEASE_BRANCH>.
> git push -f origin ${RELEASE_BRANCH}