Skip to content

Commit

Permalink
docs: update release process
Browse files Browse the repository at this point in the history
  • Loading branch information
thekaveman committed Nov 17, 2023
1 parent b7fc13e commit 76515eb
Showing 1 changed file with 5 additions and 16 deletions.
21 changes: 5 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,22 +180,11 @@ Versioning generally follows [Semantic Versioning](https://semver.org/).

## Making a release

Releases to PyPI are triggered by [publishing a release on GitHub](https://github.com/compilerla/conventional-pre-commit/releases/new).

1. Create a branch `chore/release`
1. Bump the version in `pyproject.toml`
1. PR, merge `chore/release` into `main`
1. Tag `main` with the new version (prefixed by `v`):

```bash
git fetch
git reset --hard origin/main
git tag vX.Y.Z
git push origin vX.Y.Z
```

1. Publish a pre-release to push the new package to TestPyPI
1. Publish a regular Release to push the new package to PyPI
Releases to PyPI and GitHub are triggered by pushing a tag.

1. Ensure all changes for the release are present in the `main` branch
1. Tag with the new version: `git tag vX.Y.Z` for regular release, `git tag vX.Y.Z-preN` for pre-release
1. Push the new version tag: `git push origin vX.Y.Z`

## License

Expand Down

0 comments on commit 76515eb

Please # to comment.