Skip to content

Commit bfc428b

Browse files
Add nitrokey-documentation update to release steps
This patch describes how to update the SDK documentation on docs.nitrokey.com after publishing a release.
1 parent e29b3e2 commit bfc428b

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ To create a new release:
106106
6. Create a signed tag with the version number and a `v` prefix, for example `v0.2.4`, and push it to this repository.
107107
7. [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.
108108
8. Wait for the deployment action to run and approve the deployment to [PyPI](https://pypi.org/p/nitrokey).
109+
9. Update the `NITROKEY_SDK_PY_VERSION` and `NITROKEY_SDK_PY_CHECKSUM` variables in the `Makefile` of the [nitrokey-documentation](https://github.com/nitrokey/nitrokey-documentation) repository to update the documentation on docs.nitrokey.com.
109110

110111
All commits to `main` are automatically deployed to [TestPyPI](https://test.pypi.org/p/nitrokey).
111112
It is also possible to publish release candidates (pre-releases) with a suffix like `-rc.1`.

0 commit comments

Comments
 (0)