Release

Table of contents

Release
- Table of contents
- Step by step

Step by step

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

Install git-flow: https://skoch.github.io/Git-Workflow/

Create new release branch with git-flow:

git checkout main
git pull
git checkout develop
git pull
git flow init
git flow release start X.Y.Z

Install git-cliff to update automatically the CHANGELOG.md.
```
cargo install git-cliff
git cliff -p CHANGELOG.md -u -t X.Y.Z
```
Update the links of pull requests. For example, replace (#349) by (#349).
Update the version X.Y.Z almost everywhere:
- Update in Cargo.toml
- In Dockerfile and Dockerfile.fips
- In README.md
- In documentation folder
Except:
- Cargo.lock
- CHANGELOG.md
Update the Cargo.lock file and commit
```
cargo build
git commit -m "build: release X.Y.Z"
git push
```
Make sure the CI pipeline is green.
Finish the release with git-flow:
```
git flow release finish X.Y.Z --push
```