Preparing for a new version (not release, like a milestone):
- Change the version in all crates to e.g.
0.4.0
- Pay attention to the
service-api
crate as its version will be reported externally - Pay attention to the open API spec as it does not pull its version from Cargo. See
console-backend/api/index.yaml
file.
- Pay attention to the
- Get rid of as many as possible "needs release" patches in
Cargo.toml
andconsole-frontend/Cargo.toml
- Create a new tag
- Start with a
v0.x.0-rc1
version - The final version should be
v0.x.0
- Start with a
- Push the tag
- Wait for the build
- Test the instructions in the following "Installation" subsections
- For each installation:
- Test the links on the command line
- Test the links in the web console
- Try out the example commands
- Create a branch
release-0.x
- Ensure to switch the doc version to 0.x too:
docs/antora.yml
- Ensure to switch the doc version to 0.x too:
- Release the helm charts:
- Create a
release-0.x
branch - Updates the charts
version
fields inChart.yaml
(each chart must be updated). - Note : watch out for the dependencies fields. The ^ tends to break things.
- You can look at a previous release example
- GH Actions will see the new branch and will release the charts.
- Create a
The text that goes into the final GitHub release record comes from installer/README.md