Skip to content

Commit 8b5543f

Browse files
Document release process in readme
1 parent 17df69b commit 8b5543f

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,21 @@ These make targets can be used to invoke poetry for the most common tasks:
9595

9696
For more information, see poetry’s documentation on [Managing depencies](https://python-poetry.org/docs/managing-dependencies/) and [Commands](https://python-poetry.org/docs/cli/).
9797

98+
### Publishing Releases
99+
100+
Releases are published using Github Actions.
101+
To create a new release:
102+
1. Update the `version` field in `pyproject.toml` manually or using `poetry version`.
103+
2. Update the [changelog](./CHANGELOG.md) for the release.
104+
3. Run `make update-version` to update the RPM package version.
105+
4. Commit these changes, create a PR and merge into `main`.
106+
5. Create a signed tag with the version number and a `v` prefix, for example `v0.2.4`, and push it to this repository.
107+
6. [Create a new release](https://github.com/Nitrokey/nitrokey-sdk-py/releases/new) for this tag and copy the relevant parts from the [changelog](./CHANGELOG.md) to the release description.
108+
7. Wait for the deployment action to run and approve the deployment to [PyPI](https://pypi.org/p/nitrokey).
109+
110+
All commits to `main` are automatically deployed to [TestPyPI](https://test.pypi.org/p/nitrokey).
111+
It is also possible to publish release candidates (pre-releases) with a suffix like `-rc.1`.
112+
98113
## License
99114

100115
This software is fully open source.

0 commit comments

Comments
 (0)