|
4 | 4 |
|
5 | 5 | To release a new version of HERMES when a new set of features and/or fixes have been merged, execute the following steps: |
6 | 6 |
|
7 | | -1. Adjust the version number in `pyproject.toml` as necessary (major, minor or patch release). |
8 | | - Please create and merge a PR for this. Don't just push to `develop`. |
9 | | - To edit the version, you can use two ways: |
| 7 | +1. Adjust the version number in `pyproject.toml` and `CITATION.cff` as necessary (major, minor or patch release). |
| 8 | + Please create a branch `release/v<version>` and merge it in a PR - don't just push to `develop`. |
| 9 | + After merging, delete the "release" branch. |
| 10 | + |
| 11 | + To edit the version in `pyproject.toml`, there are two ways: |
10 | 12 | - Manually edit the file with an editor. |
11 | 13 | - Use `poetry version <rule>`. See also [Poetry Docs](https://python-poetry.org/docs/cli/#version) |
| 14 | + |
12 | 15 | 2. Create a pull request from `develop` to `main`. |
13 | 16 | 3. Check if all the CI pipelines for that PR succeed. |
14 | 17 | 3. Let the named maintainer (see GOVERNANCE.md) merge the PR into `main`. |
15 | 18 | 4. Create a new release [by using the Github UI](https://github.com/softwarepub/hermes/releases/new). |
16 | | - This also ensures usage of *annotated* tags to include releases in Software Heritage Archive. |
17 | 19 | - Choose to create a new tag with the format `v<version number>`. |
18 | 20 | - Target branch is `main`. |
19 | 21 | - The release title will be set to the tag name, keep as is. |
20 | 22 | - A description should be added, giving a very brief summary of the contained changes. |
21 | 23 | - Publish the release. |
| 24 | + |
| 25 | + Note: this will also ensure usage of *annotated* tags, making Software Heritage archive the release. |
22 | 26 | 5. On `develop`, update the version in `pyproject.toml` to `<major>.<minor+1>.0.dev0` in another pull request. |
23 | 27 | To edit the version, you can use two ways: |
24 | 28 | - Manually edit the file with an editor. |
|
0 commit comments