Skip to content

Commit 76515eb

Browse files
committed
docs: update release process
1 parent b7fc13e commit 76515eb

File tree

1 file changed

+5
-16
lines changed

1 file changed

+5
-16
lines changed

README.md

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -180,22 +180,11 @@ Versioning generally follows [Semantic Versioning](https://semver.org/).
180180

181181
## Making a release
182182

183-
Releases to PyPI are triggered by [publishing a release on GitHub](https://github.com/compilerla/conventional-pre-commit/releases/new).
184-
185-
1. Create a branch `chore/release`
186-
1. Bump the version in `pyproject.toml`
187-
1. PR, merge `chore/release` into `main`
188-
1. Tag `main` with the new version (prefixed by `v`):
189-
190-
```bash
191-
git fetch
192-
git reset --hard origin/main
193-
git tag vX.Y.Z
194-
git push origin vX.Y.Z
195-
```
196-
197-
1. Publish a pre-release to push the new package to TestPyPI
198-
1. Publish a regular Release to push the new package to PyPI
183+
Releases to PyPI and GitHub are triggered by pushing a tag.
184+
185+
1. Ensure all changes for the release are present in the `main` branch
186+
1. Tag with the new version: `git tag vX.Y.Z` for regular release, `git tag vX.Y.Z-preN` for pre-release
187+
1. Push the new version tag: `git push origin vX.Y.Z`
199188

200189
## License
201190

0 commit comments

Comments
 (0)