Skip to content

Latest commit

 

History

History
332 lines (217 loc) · 12.5 KB

RELEASING.md

File metadata and controls

332 lines (217 loc) · 12.5 KB
Raw

How to release Calico

NOTE: These instructions apply only to Calico versions v3.2.0 or greater. For older releases, refer to the instructions in the corresponding release-vX.Y branch.

Overview

This repository contains documentation and packaging, but no Calico code.

Releases of this repository still serve several important purposes. Namely, they provide:

  • a single Calico release with user-facing release notes and documentation.
  • a packaging of individual Calico component releases into a single .tgz file

Prerequisites

To release Calico, you need the following permissions:

  • Write access to the core repositories in the projectcalico/ GitHub organization.

  • Push access to the Calico DockerHub repositories. Assuming you've been granted access by an admin:

    docker login

  • Push access to the Calico quay.io repositories. Assuming you've been granted access by an admin:

    docker login quay.io

  • Push access to the gcr.io/projectcalico-org repositories. Note: Some of the repos do not yet support credential helpers, you must use one of the token-based logins. For example, assuming you've been granted access, this will configure a short-lived auth token:

    gcloud auth print-access-token | docker login -u oauth2accesstoken --password-stdin https://gcr.io

You'll also need several GB of disk space (~7GB for v3.4.0, for example).

Some of the release scripts also require tools to be installed in your dev environment:

  • Install and configure the GitHub hub tool.

  • Create a personal access token for Github and export it as the GITHUB_TOKEN env var (for example by adding it to your .profile.

  • Install the "GitHub release" tool, ghr:

    go get -u github.com/tcnksm/ghr

Finally, the release process assumes that your repos are checked out with name origin for the git remote for the main Calico repo.

Releasing the subcomponents

Before attempting to create a Calico release you must do the following.

  1. Choose a Calico version number, e.g. v3.2.0.

  2. Select the appropriate component version numbers, and create any necessary releases. Follow the instructions in each repository for further information.

    The following components must use the same version number as the Calico version number chosen above, and thus must be re-released for every Calico release.

    The following components must use the same minor revision number as the Calico version number above, but do not always need to be released for every patch. They must be cut as part of a minor release of Calico.

    The following components do not share a version with the Calico release, but are included in the documentation.

Preparing to cut a Calico release

  1. Check out the master branch of this repository and make sure it is up-to-date and passing Semaphore CI.

    git checkout master && git pull origin master

Your next steps depend on the type of release:

Creating a new major / minor release

This section describes how to create a new major or minor release, which may or may not be a release candidate.

  1. Create a new branch off of the latest master.

    git checkout -b <NEW_PERSONAL_BRANCH>

  2. Create the release-versioned directories for the documentation, copying from master directories.

    python2 ./release-scripts/do_release.py

  3. Add the new version to the bottom of _data/versions.yml.

    This ensures the release is not listed as the "Latest release" in the documentation. Populate the section with the chosen component versions for this release.

    For example:

     v2.1
   - title: v2.1.0-rc1
     ... etc ...

  4. Add a section in _config.yml so that page.version will be set correctly in the new subdirectory:

    -
  scope:
    path: vX.Y
  values:
    version: vX.Y

  5. If appropriate, update the list of tested versions for different platforms in the appropriate documents.

    • Kubernetes vX.Y/getting-started/kubernetes/requirements.md
    • OpenShift vX.Y/getting-started/openshift/requirements.md
    • OpenStack vX.Y/getting-started/openstack/requirements.md
    • Host protection vX.Y/getting-started/bare-metal/requirements.md

  6. Update the AUTHORS.md file. This will require GITHUB_TOKEN be set in your environment.

    make update-authors

  7. Follow the steps in writing release notes to generate candidate release notes.

    Then, add the newly created release note file to git.

    git add _data/<VERSION>/release-notes/<VERSION>-release-notes.md

  8. Commit your changes. For example:

    git commit -m "Updates for release vX.Y"

  9. Run the following on your local branch in order to build and publish the release at the newly created commit.

    make RELEASE_STREAM=vX.Y release

    Then, publish the tag and release.

    make RELEASE_STREAM=vX.Y release-publish

    Follow the steps on screen, which will instruct you to upload the release-<VERSION>.tgz artifact to the GitHub release.

  10. Push your branch and open a pull request. Get it reviewed and wait for it to pass CI.

    Once reviewed and CI is passing, merge the PR. This will cause the live docs site to be updated (after a few minutes).

  11. Review _config_dev.yml and edit it to exclude any previous releases that we now don't want to continue testing.

If the release is not a release candidate but in fact a stable release, then you must also follow the steps in the next section for promoting a release candidate to a final release.

Promoting a release candidate to a final release

The following steps outline how to promote a major / minor release candidate to the latest release in the documentation. Perform these steps on a branch off of master.

Promoting to the latest release

  1. Add TWO new <li> entries to the <span class="dropdown"> in _layouts/docwithnav.html file.

  2. Modify the redirect in /index.html to point to your new release.

  3. Move the section for the release in _data/versions.yml to the top of the file so that it will be the 'Latest Release', and remove any release candidates from the section.

  4. Run make add_redirects_for_latest VERSION=vX.Y to update the redirects.

  5. Commit your current changes.

  6. Update sitemap-latest.xml in the root of the repository. This is still a manual process. Use _site/sitemap.xml as a guide.

  7. Commit the sitemap changes as a new commit and open a pull request, make sure it passes CI and get it reviewed.

    Once reviewed and CI has passed, merge the PR. This will cause the live docs site to be updated (after a few minutes).

Updating canonical redirects

  1. Pull the latest master and check out a new branch.

  2. Update the canonical URLs to point at the new release.

    Run the following command to switch the canonical URLs to the latest release version number. Pass in the number of the previous release via OLD and the number of the current latest release via NEW.

    make update_canonical_urls OLD=vX.Y NEW=vX.Y

    Example: make update_canonical_urls OLD=v3.0 NEW=v3.1, where 3.0 was the previous latest and 3.1 is the new latest release.

  3. Submit a PR with the canonical link changes, make sure it passes CI, and get it reviewed.

    make htmlproofer

    NOTE: You may experience htmlproofer errors at this stage if a page was deleted or renamed in the master directory. Such errors can also occur if a page was deleted or renamed in the latest release and the master directories but the canonical links were not updated according to the instructions in CONTRIBUTING_DOCS.md. Modify the canonical_url metadata of the pages that error out so that they point to valid locations. If the page was deleted, adjust the version number of the canonical URLs to the final copy of the page. If the page was renamed, update the canonical URLs to the new path.

Update the custom search engine

  1. Go to the Calico Docs Custom Search Engine.
  2. Navigate to: search engine -> Search Features -> Refinements -> Add
  3. Add a new refinement name: vX.Y
  4. Navigate to: Setup -> Basics
  5. Under "Sites to search", select "Add", for the url use docs.projectcalico.org/vX.Y
  6. Choose vX.Y from the "Label" dropdown.

Performing a "patch" release

Creating the release

  1. On a new branch, add the new version to the correct release section in _data/versions.yml

  2. Follow the steps in writing release notes to generate candidate release notes.

    Then, add the newly created release note file to git.

    git add _data/<VERSION>/release-notes/<VERSION>-release-notes.md

  3. Commit your changes. For example:

    git commit -m "Updates for release vX.Y"

  4. Run the following on your local branch in order to build and publish the release at the newly created commit.

    make RELEASE_STREAM=vX.Y release

    Then, publish the tag and release.

    make RELEASE_STREAM=vX.Y release-publish

    Follow the steps on screen, which will instruct you to upload the release-<VERSION>.tgz artifact to the GitHub release.

  5. Push your branch and open a pull request. Get it reviewed and wait for it to pass CI.

    Once reviewed and CI is passing, merge the PR. This will cause the live docs site to be updated (after a few minutes).

Release notes

Release notes for a Calico release contain notable changes across Calico repositories. To write release notes for a given version, perform the following steps.

  1. Check the merged pull requests in the milestone and make sure each has a release note if it needs one.

    Use this URL to query for PRs, replacing vX.Y.Z with your desired version.

    https://github.com/issues?utf8=%E2%9C%93&q=user%3Aprojectcalico+milestone%3A%22Calico+vX.Y.Z%22+

    Each PR that wants a release note must meet the following conditions to have its release note considered:

    • It is in the correct Calico vX.Y.Z GitHub milestone
    • It has the release-note-required label
    • It has one or more release notes included in the description (Optional).

  2. Run the following command to collect all release notes for the given version.

    make RELEASE_STREAM=vX.Y release-notes

    A file called <VERSION>-release-notes.md will be created with the raw release note content.

    NOTE: If you receive a ratelimit error, you can specify a GITHUB_TOKEN in the above command to increase the number of allowed API calls. See here for details.

  3. Edit the generated file.

    The release notes should be edited to highlight a few major enhancements and their value to the user. Bug fixes and other changes should be summarized in a bulleted list at the end of the release notes. Any limitations or incompatible changes in behavior should be explicitly noted.

    Consistent release note formatting is important. Here are some examples for reference: