Skip to content

Commit

Permalink
Update publishing workflow docs
Browse files Browse the repository at this point in the history
  • Loading branch information
grst authored Dec 10, 2024
1 parent 51df89e commit f8dbc66
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,12 +78,13 @@ out to the developers of the dependency before the package is released to a wide

[scanpy-test-docs]: https://scanpy.readthedocs.io/en/latest/dev/testing.html#writing-tests

## Publishing a release
## Making a release

### Updating the version number
1. **Review and update the changelog.** Make sure the changelog is up-to-date and change the top line from `[Unreleased]` to the version number you intend to publish.
2. **Create a release on GitHub.** Navigate to the "Releases" page of this project on GitHub. Specify vX.X.X as a tag name and create a release. For more information, see [managing GitHub releases][].

Scirpy uses [hatch-vcs](https://github.com/ofek/hatch-vcs) to automaticlly retrieve the version number
from the git tag. To make a new release, navigate to the “Releases” page of this project on GitHub. Specify vX.X.X as a tag name and create a release. For more information, see [managing GitHub releases][]. This will automatically create a git tag and trigger a Github workflow that creates a release on PyPI.
**That's it!** The release will be built automatically and published on PyPI using GitHub actions using the [trusted publishing workflow](https://docs.pypi.org/trusted-publishers/).
Scirpy uses [hatch-vcs](https://github.com/ofek/hatch-vcs) to automaticlly retrieve the version number from the git tag. Therefore, it is not necessary to bump versions in the code.

## Writing documentation

Expand Down

0 comments on commit f8dbc66

Please sign in to comment.