Skip to content

Commit

Permalink
DOC: Update docs/releasing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kojiishi committed Mar 18, 2024
1 parent e57c628 commit 8534cea
Showing 1 changed file with 25 additions and 5 deletions.
30 changes: 25 additions & 5 deletions docs/releasing.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,30 @@
# Releasing

Create a new release at [Releases].

The [`publish.yml` action]
automatically publishes the release to [PyPI].
1. Update the version in `pyproject.toml`.
If the update is a patch, run:
```sh
poetry version patch
```
See [poetry version document] for other valid bump rules.
2. Commit the change and push.
```sh
git commit -a
git push
```
3. Create a new release at [Releases].
The [`publish.yml` action]
automatically publishes the release to [PyPI].
4. Update the version to prerelease.
```sh
poetry version prepatch
```
5. Commit the change and push. For example:
```sh
git commit -a -m 'v1.4.3-alpha.0'
git push
```

[poetry version document]: https://python-poetry.org/docs/cli/#version
[`publish.yml` action]: https://github.com/kojiishi/east_asian_spacing/blob/main/.github/workflows/publish.yml
[PyPI]: https://pypi.org/project/east-asian-spacing/
[Releases]: https://github.com/kojiishi/east_asian_spacing/releases
[Releases]: https://github.com/kojiishi/east_asian_spacing/releases

0 comments on commit 8534cea

Please sign in to comment.