This document outlines the process for contributing to the project, including how to prepare and publish a new release.
[This section can be filled out later with details about the development workflow, such as branching strategy, code style, and testing requirements.]
The release process is divided into two main parts: preparing a release and publishing it. This is to ensure that version numbers are consistent and that releases are made from the main branch in a controlled manner.
This step updates the application version and should be done in a pull request to allow for review.
-
From the
mainbranch, create a new branch for the release preparation (e.g.,release/prepare-0.5.0). -
Run the
prepare-release.pyscript with the target version number. The version should follow semantic versioning (e.g.,1.2.3or1.2.3-rc.1for release candidates)../scripts/prepare-release.py <version>
For example:
./scripts/prepare-release.py 0.5.0
This script will:
- Validate the version number format.
- Check if a Git tag for the specified version already exists.
- Update the version in
backend/Cargo.toml.
-
Commit the changes to
backend/Cargo.toml. -
Push the branch and create a pull request to
main.
After the release preparation pull request has been merged into main, the release can be published. This step should only be performed on the main branch.
-
Ensure your local
mainbranch is up-to-date with the remote repository.git checkout main git pull origin main
-
Run the
tag-release.pyscript../scripts/tag-release.py
This script will:
- Read the version from
backend/Cargo.toml. - Verify that you are on the
mainbranch and that it is up-to-date withorigin/main. - Check that your working directory is clean.
- Check that a tag for the current version doesn't already exist.
- Create a new Git tag for the version (e.g.,
0.5.0). - Push the new tag to the remote repository (
origin).
- Read the version from
Once the tag is pushed, the CI/CD pipeline should automatically trigger to build and publish the release artifacts.