Skip to content

Commit

Permalink
Merge pull request #43 from ru-fu/add-release-info
Browse files Browse the repository at this point in the history
add information about releases and the release process
  • Loading branch information
ru-fu authored Aug 12, 2024
2 parents 86ddc05 + e5c0f5b commit 5d7a707
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions RELEASES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Releases

Releases are done to PyPI directly from the main branch.

This usually happens after every merge.
Check the commit log and the date of the latest [PyPI release](https://pypi.org/project/canonical-sphinx-extensions/#history) to see which changes are included.

## Publish a release

To publish a release, first make sure that the version number in `setup.cfg` is increased.
Otherwise, publishing will give an error.

Then manually trigger the "Publish canonical-sphinx-extensions to PyPI" workflow on the main branch.
To do so, you must have Write permission on the repository.

0 comments on commit 5d7a707

Please sign in to comment.