This project uses Poetry for packaging and dependency management.
We’re using the following tools to ensure consistency and quality
To release a new version of this project follow these steps:
-
Replace the “Upcoming” heading of the changelog with the new version number and date of release.
-
Update the version in
pyproject.toml -
Commit the changes with the commit message “Release vX.Y.Z” to
main. -
Tag the main 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) -
Push the main branch and tag with
git push --tags -
Create a release on Github using the version as the title and the changelog entries as the description.
-
Publish the new version to PyPI with
poetry publish.