python-fido2/RELEASE.adoc

55 lines
1.3 KiB
Plaintext
Raw Normal View History

2019-09-20 10:05:15 +02:00
== Release instructions
* Create a release branch:
$ git checkout -b release/x.y.z
2022-06-08 09:16:03 +02:00
* Update the version in pyproject.toml and fido/__init__.py and make sure the
NEWS file has an entry for it, and the correct release date.
2019-09-20 10:05:15 +02:00
* Commit the changes, and push the new branch.
$ git push -u origin release/x.y.z
* Wait for CI to complete, and make sure nothing fails.
* Create a signed tag using the version number as name:
$ git tag -s -m x.y.z x.y.z
* Build the release:
2022-06-08 09:16:03 +02:00
$ poetry build
2019-09-20 10:05:15 +02:00
2022-06-08 09:16:03 +02:00
* Sign the release:
2019-09-20 10:05:15 +02:00
$ gpg --detach-sign -a dist/fido2-x.y.z.tar.gz
2022-06-08 09:16:03 +02:00
$ gpg --detach-sign -a dist/fido2-x.y.z-py3-none-any.whl
2019-09-20 10:05:15 +02:00
* Upload the release to PyPI:
2022-06-08 09:16:03 +02:00
$ poetry publish
2019-09-20 10:05:15 +02:00
2022-06-08 09:16:03 +02:00
* Add the .tar.gz, the .whl and .sig files to a new Github release, using the
latest NEWS entry as description.
2019-09-20 10:05:15 +02:00
2022-06-08 09:16:03 +02:00
* Merge and delete the release branch, and push the tag:
2019-09-20 10:05:15 +02:00
2022-10-17 16:09:12 +02:00
$ git checkout main
2019-09-20 10:05:15 +02:00
$ git merge --ff release/x.y.z
$ git branch -d release/x.y.z
$ git push && git push --tags
2019-11-25 11:44:08 +01:00
$ git push origin :release/x.y.z
2019-09-20 10:05:15 +02:00
2022-06-08 09:16:03 +02:00
* Bump the version number by incrementing the PATCH version and appending -dev.0
2022-10-17 16:09:12 +02:00
in pyproject.toml and fido2/__init__.py and add a new entry (unreleased) to the
NEWS file.
2019-09-20 10:05:15 +02:00
2022-10-17 16:09:12 +02:00
# pyproject.toml:
version = "x.y.q-dev.0"
# fido2/__init__.py:
2022-06-08 09:16:03 +02:00
__version__ = 'x.y.q-dev.0'
2021-01-20 10:38:52 +01:00
2019-09-20 10:05:15 +02:00
* Commit and push the change:
$ git commit -a -m "Bump version." && git push