Release Process

2 min

The release process is intended to be run by an Aerogramme maintainer. It is made available to everyone for transparency.

Most of the release process is done through Nix (from the NixOS/nixpkg project).

Create a release branch

In the Aerogramme git repo:

git checkout main
git pull
git checkout -b release-xxx
git push

Update the Cargo version

Edit all the Cargo.toml files of the project. A non-exhaustive list:

  • Cargo.toml ([workspace.dependencies] section)
  • aerogramme/Cargo.toml
  • aero-bayou/Cargo.toml
  • aero-collections/Cargo.toml
  • ...
  • smtp-message/Cargo.toml
  • smtp-server/Cargo.toml
  • ...

Update Cargo.nix

Start a cargo2nix shell:

nix develop

And then update Cargo.nix with:

cargo2nix

Commit the changes.

Build the artifacts

Run:

nix run .#tools.build

Note: it takes a lot of time. Be patient, use a more powerful machine, or configure a NixOS build cluster if you want to make the process faster. I'm often running the command during the night.

Check that folders static/ and docker/ have been populated.

Push the artifacts

You need:

  • docker login to be run & configured with an account with appropriate permission
  • AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY env var set and configured so you can upload to registry.deuxfleurs.org and download.deuxfleurs.org

Then run:

nix run .#tools.push

It should be quite fast.

Check that https://aerogramme.deuxfleurs.fr/download/ has been properly updated

Merge and tag

Once your release is done, tag the final commit you use to build the project, push the tag, and merge the branch (do not squash or run any commit/history rewriting logic).

Create a release from the Forgejo UI pinned to the tag you just created. Write a changelog following the patterns started in the previous releases.

Send a message where it is relevant to announce the new version.

Navigation