RELEASE.md

Release

Table of contents

• Release
  • Table of contents
  • Step by step

Step by step

To proceed a new release, please follow the steps below:

1. Create a new git-branch: git checkout -b release/X.Y.Z. Refer to the CHANGELOG.md for the version number.

2. (Possibly) Release the Cosmian Base VM image.

   • Increase the version number in the CHANGELOG_BASE_IMAGES.md file.
   • Increase the version number in the README.md file, Section Versions correspondence.
   • Edit the CHANGELOG.md file to add a new line describing the Cosmian Base Image changes.
   • Replace all old version numbers of the Cosmian Base VM image in:
     • base_main.yml
     • release_main.yml
   • Commit the changes: git commit -am "chore: create new Cosmian Base Image version X.Y.Z" && git push
   • Eventually discard the pipelines related to the last commit.
   • Run manually the workflow Manual base images recreation
     • Run workflow on branch release/X.Y.Z

3. Release the Cosmian VM images.

   • Increase the version number in the CHANGELOG.md file.
   • Increase the version number in the README.md file, Section Versions correspondence.
   • Increase the version number in the cargo.toml root file.
   • Do a cargo build a the root of the project to update the Cargo.lock file.
   • Replace everywhere old version numbers of the Cosmian VM image. In particular, in these 2 files:
     • pull_request.yml
     • release_main.yml
   • Once the CI pipeline is green, merge it into the main branch.
   • Next, create a final tag to launch the release pipeline which will publish the Cosmian VM images on the marketplaces:
     • git tag X.Y.Z -m "fix: this is why we did a new version"
     • git push --tags

4. Edit and update Github release description:

   • Copy the CHANGELOG.md new entry in the GitHub release page.