From 8534cea1957a3f2da48662c8f6449e6e5372dbe3 Mon Sep 17 00:00:00 2001 From: Koji Ishii Date: Mon, 18 Mar 2024 22:38:41 +0900 Subject: [PATCH] DOC: Update docs/releasing.md --- docs/releasing.md | 30 +++++++++++++++++++++++++----- 1 file changed, 25 insertions(+), 5 deletions(-) diff --git a/docs/releasing.md b/docs/releasing.md index af3c83b..5f59625 100644 --- a/docs/releasing.md +++ b/docs/releasing.md @@ -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 \ No newline at end of file +[Releases]: https://github.com/kojiishi/east_asian_spacing/releases