Skip to content

Commit

Permalink
Merge pull request #57 from geigerzaehler/add-developer-guide
Browse files Browse the repository at this point in the history
Add developer guide with release guide
  • Loading branch information
geigerzaehler authored Jul 1, 2020
2 parents 3c310c2 + 0fecf20 commit c13c179
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions DEVELOPING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
Developer Guide
===============

Releasing
---------

To release a new version of this project follow these steps:

1. Replace the “Upcoming” heading of the changelog with the new version number
and date of release.
2. Update the version in `setup.py`
3. Commit the changes with the commit message “Release vX.Y.Z” to `master`.
4. Tag the master branch with a signed and annotated tag: `git tag -as vX.Y.Z`.
Use the version and date as the tag title and the changelog entry as the tag body. E.g.
```
v0.10.0 - 2019-08-25
* Symlink views now support relative symlinks (@daviddavo)
```
5. Push the master branch and tag with `git push --tags`
6. Create a release on Github using the version as the title and the changelog
entries as the description.
7. Upload the new version to PyPI with the following commands
```
rm dist
python3 setup.py sdist bdist_wheel
twine upload dist/*
```

0 comments on commit c13c179

Please sign in to comment.