Skip to content

Commit 766ab13

Browse files
committed
docs: describe basic release steps
1 parent 4db44b2 commit 766ab13

File tree

1 file changed

+23
-4
lines changed

1 file changed

+23
-4
lines changed

README.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -115,10 +115,6 @@ print(is_conventional("nope: this is not a conventional commit"))
115115
print(is_conventional("custom: this is a conventional commit", types=["custom"]))
116116
```
117117

118-
## Versioning
119-
120-
Versioning generally follows [Semantic Versioning](https://semver.org/).
121-
122118
## Development
123119

124120
`conventional-pre-commit` comes with a [VS Code devcontainer](https://code.visualstudio.com/learn/develop-cloud/containers)
@@ -136,6 +132,29 @@ If you do not receive a prompt, or when you feel like starting from a fresh envi
136132
1. Select `Rebuild and Reopen in Container` to completely rebuild the devcontainer
137133
1. Select `Reopen in Container` to reopen the most recent devcontainer build
138134

135+
## Versioning
136+
137+
Versioning generally follows [Semantic Versioning](https://semver.org/).
138+
139+
## Making a release
140+
141+
Releases to PyPI are triggered by [publishing a release on GitHub](https://github.com/compilerla/conventional-pre-commit/releases/new).
142+
143+
1. Create a branch `chore/release`
144+
1. Bump the version in `pyproject.toml`
145+
1. PR, merge `chore/release` into `main`
146+
1. Tag `main` with the new version (prefixed by `v`):
147+
148+
```bash
149+
git fetch
150+
git reset --hard origin/main
151+
git tag vX.Y.Z
152+
git push origin vX.Y.Z
153+
```
154+
155+
1. Publish a pre-release to push the new package to TestPyPI
156+
1. Publish a regular Release to push the new package to PyPI
157+
139158
## License
140159

141160
[Apache 2.0](LICENSE)

0 commit comments

Comments
 (0)