From 76515ebb23c55b299797b67f02198e9775addadb Mon Sep 17 00:00:00 2001 From: Kegan Maher Date: Fri, 17 Nov 2023 20:04:10 +0000 Subject: [PATCH] docs: update release process --- README.md | 21 +++++---------------- 1 file changed, 5 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 053e58e..ccb30f4 100644 --- a/README.md +++ b/README.md @@ -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