Skip to content

Commit

Permalink
add notes on releasing
Browse files Browse the repository at this point in the history
  • Loading branch information
richvdh committed Mar 27, 2020
1 parent b4fc77d commit ffda035
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
1. Set a variable to the version number for convenience:
```sh
ver=x.y.z
```
1. Update the changelog:
```sh
towncrier --version=$ver
```
1. Push your changes:
```sh
git add -u && git commit -m $ver && git push
```
1. Sanity-check the
[changelog](https://github.com/matrix-org/python-signedjson/blob/master/CHANGELOG.md)
and update if need be.
1. Create a signed tag for the relese:
```sh
git tag -s v$ver
```
Base the tag message on the changelog.
1. Push the tag:
```sh
git push origin tag v$ver
```
1. Build and upload to PyPI:
```sh
python setup.py sdist
twine upload dist/python-signedjson-$ver.tar.gz
```
1. Create release on GH project page:
```sh
xdg-open https://github.com/matrix-org/python-signedjson/releases/edit/v$ver
```

0 comments on commit ffda035

Please sign in to comment.