people/docs/release.md

Releasing a new version

Whenever we are cooking a new release (e.g. 4.18.1) we should follow a standard procedure described below:

1. Checkout and pull changes from the main branch to ensure you have the latest updates.

   git checkout main
   git pull
   

2. The next steps are automated in the scripts/release.py, you can run it using:

   make release
   

   This script will ask you for the version you want to release and the kind of release (patch, minor, major). It will then:

   1. Create a new branch named: release/4.18.1.

   2. Bump the release number for backend project, frontend projects:

      • for backend, update the version number by hand in pyproject.toml,
      • for each project (src/frontend, src/frontend/apps/*, src/mail), run yarn version --new-version --no-git-tag-version 4.18.1 in their directory. This will update their package.json for you.

   3. Update the project's Changelog following the keepachangelog recommendations

   4. Commit your changes with the following format: the 🔖 release emoji, the type of release (patch/minor/patch) and the release version:

      🔖(minor) bump release to 4.18.0
      

3. Open a pull request and ait for an approval from your peers and merge it.

4. Tag and push your commit:

   git tag v4.18.1 && git push origin tag v4.18.1
   

   Doing this triggers the CI and tells it to build the new Docker image versions that you targeted earlier in the Helm files.

5. Ensure the new backend and frontend image tags are on Docker Hub.

6. The release is now done!

Deploying

Tip

The staging platform is deployed automatically with every update of the main branch.

Making a new release doesn't publish it automatically in production.

Deployment is done by ArgoCD. ArgoCD checks for the production tag and automatically deploys the production platform with the targeted commit.

To publish, we mark the commit we want with the production tag. ArgoCD is then notified that the tag has changed. It then deploys the Docker image tags specified in the Helm files of the targeted commit.

To publish the release you just made:

git tag --force production v4.18.1
git push --force origin production