Skip to content
This repository has been archived by the owner on May 6, 2020. It is now read-only.

Release Checklist

James O. D. Hunt edited this page Sep 13, 2017 · 8 revisions

Change release process, instead create a release candidate we can test the HEAD what will be the last commit using new automated obs package generation we can generate and test commits based on HEAD.

  • Test the HEAD commit of the master branch using the tests included in the tests repository.
  • Run Coverity Scan on the shim's HEAD commit and ensure no medium or high severity issues are reported.
  • Update VERSION in the runtime repository.
  • Update the versions of cc-proxy and cc-shim.
    (Note that the "phase" element of the project encoded in the version strings needs to match for all components. For example, when a beta is released, the version string for all components should show beta).
  • Generate OBS packages based on HEAD.
  • Test OBS packages
    • Manual tests
      • Installation tests (must be done for major releases)
        • CentOS
        • Fedora
        • RHEL
        • Ubuntu
      • Package signature test.
    • Automated tests
      • Integration tests included in the tests repository under the integration directory.
  • Create an annotated tag for the new release version (required by git describe)
  • Write release notes:
    • Brief summary of known issues, pointing to the appropriate Issues/PRs.
    • Version of Docker (ideally range of versions, or "up to version X") supported by the release.
    • Version of the OCI spec (ideally range of versions, or "up to version X") supported by the release.
    • Version of Clear Container image used by the release.
    • Add links to Installation instructions.
    • Document any common vulnerabilities and exposures (CVEs) fixed with links to the CVE database.
  • Check if the limitations doc needs updating.
  • Post release details on the public mailing list.
  • Update public IRC channel with a link to the latest release.