Skip to content

Latest commit

 

History

History
38 lines (28 loc) · 1.68 KB

RELEASE.md

File metadata and controls

38 lines (28 loc) · 1.68 KB

Releases

Schedule

The release schedule for this project is ad-hoc. Given the pre-1.0 status of the project we do not have a fixed release cadence. However if a vulnerability is discovered we will respond in accordance with our security policy and this response may include a release.

Process

There is a semi-automated release process for this project. When you create a Git tag with a tagname that has a v prefix and push it to GitHub it will trigger the release workflow.

The release process for this repo is documented below:

  1. Create a tag for the new release:
    export VERSION=v0.5.0-alpha.0
    git tag --annotate --message="Release ${VERSION}" "${VERSION}"
    git push origin "${VERSION}"
  2. A GitHub action will see the new tag and do the following:
    • Build the binaries
    • Create checksums for the binaries
    • Sign the checksums
    • Create a draft GitHub release
    • Upload binaries, checksums and signature to the GitHub release
  3. Visit the releases page, edit the draft release, click "Generate release notes", then edit the notes to add the following to the top
    cmctl is the command line tool for interacting with cert-manager.
    
  4. Publish the release.

Artifacts

This repo will produce the following artifacts each release. For documentation on how those artifacts are produced see the "Process" section.

  • Binaries - The cmctl binary is created and attached to the GitHub release, along with its shasum