chore: add __version__ and automated tools to update it

- also add a checker to verify that versions are in sync
This commit is contained in:
Arthur Meyre
2021-09-30 16:21:15 +02:00
parent edcbc0cffd
commit 6fc6991839
5 changed files with 102 additions and 3 deletions

View File

@@ -10,7 +10,13 @@ Release check-list:
<!-- Note that some of these steps will be automated in the future -->
If it was not already done:
- [ ] Choose the version number, e.g. `vX.Y.Z` (can be `vX.Y.Zrc?` for Release Candidates) following semantic versioning: https://semver.org/
- [ ] Update the version in pyproject.toml to `X.Y.Z` (or `X.Y.Zrc?`)
- [ ] Update the project version to `X.Y.Z` (or `X.Y.Zrc?`) by running:
```bash
VERSION=X.Y.Z make set_version
# or
VERSION=X.Y.Zrc? make set_version
```
Then:
- [ ] For non RC releases: check the release milestone issues, cut out what can't be completed in time and change the milestones for these issues
@@ -26,6 +32,12 @@ This is the release markdown template you should copy and update:
To continue the release cycle:
- [ ] Choose the version number for next release, e.g. `vA.B.C` (can be `vA.B.Crc?` for Release Candidates) following semantic versioning: https://semver.org/
- [ ] Update the version in pyproject.toml to `A.B.C` (or `A.B.Crc?`)
- [ ] Update the project version to `A.B.C` (or `A.B.Crc?`) by running:
```bash
VERSION=A.B.C make set_version
# or
VERSION=A.B.Crc? make set_version
```
All done!