Skip to content

Latest commit

 

History

History
81 lines (55 loc) · 2.39 KB

RELEASING.md

File metadata and controls

81 lines (55 loc) · 2.39 KB
Raw

Release process

Resulting artifacts

Creating a new release creates the following artifacts:

  • Container images:

    • calico/ctl:$VERSION and calico/ctl:latest
    • quay.io/calico/ctl:$VERSION and quay.io/calico/ctl:latest

  • Binaries (stored in the dist directory) :

    • calicoctl
    • calicoctl-darwin-amd64
    • calicoctl-windows-amd64.exe

Preparing for a release

Checkout the branch from which you want to release. For a major or minor release, you will need to create a new release-vX.Y branch based on the target Calico version.

Make sure the branch is in a good state, e.g. Update any pins in go.mod, create PR, ensure tests pass and merge.

You should have no local changes and tests should be passing.

Creating a patch release

  1. Choose a version e.g. v1.0.1

  2. Create the release. This will generate release notes, a tag, build the code, and verify the artifacts.

    make VERSION=v1.0.1 release

  3. Publish the release.

    make VERSION=v1.0.1 release-publish

  4. Publish the release on GitHub by following the link printed to screen.

    • Copy the tag description, press edit, and paste it into the release body.
    • Remove or clean up any messy commits - e.g. libcalico-go updates.
    • Title the release the same as the tag - e.g. v1.0.1
    • Press "Publish release"

  5. If this is the latest stable release, perform the following step to publish the latest images. Do not perform this step for patches to older releases.

    make VERSION=<version> release-publish-latest

Creating a major / minor release

  1. Choose a version e.g. v1.1.0

  2. Create the release. This will generate release notes, a tag, build the code, and verify the artifacts.

    make VERSION=v1.1.0 PREVIOUS_RELEASE=v1.0.0 release

  3. Publish the release.

    make VERSION=v1.1.0 release-publish

  4. Publish the release on GitHub by following the link printed to screen.

    • Copy the tag description, press edit, and paste it into the release body.
    • Remove or clean up any messy commits - e.g. libcalico-go updates.
    • Title the release the same as the tag - e.g. v1.1.0
    • Press "Publish release"

  5. If this is the latest stable release, perform the following step to publish the latest images. Do not perform this step for patches to older releases.

    make VERSION=<version> release-publish-latest