Skip to content

Commit 0144ee3

Browse files
Update publishing workflow docs (#580)
* Update publishing workflow docs * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent 51df89e commit 0144ee3

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

docs/contributing.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -78,12 +78,13 @@ out to the developers of the dependency before the package is released to a wide
7878

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

81-
## Publishing a release
81+
## Making a release
8282

83-
### Updating the version number
83+
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.
84+
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][].
8485

85-
Scirpy uses [hatch-vcs](https://github.com/ofek/hatch-vcs) to automaticlly retrieve the version number
86-
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.
86+
**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/).
87+
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.
8788

8889
## Writing documentation
8990

0 commit comments

Comments
 (0)