1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
|
# How to make a release
`autodoc-traits` is a package available on [PyPI][].
These are instructions on how to make a release.
## Pre-requisites
- Push rights to [jupyterhub/autodoc-traits][]
## Steps to make a release
1. Create a PR updating `CHANGELOG.md` with [github-activity][] and continue
only when its merged.
```shell
pip install github-activity
github-activity --heading-level=3 jupyterhub/autodoc-traits
```
1. Checkout main and make sure it is up to date.
```shell
git checkout main
git fetch origin main
git reset --hard origin/main
```
1. Update the version, make commits, and push a git tag with `tbump`.
```shell
pip install tbump
tbump --dry-run ${VERSION}
tbump ${VERSION}
```
Following this, the [CI system][] will build and publish a release.
1. Reset the version back to dev, e.g. `2.1.0.dev` after releasing `2.0.0`
```shell
tbump --no-tag ${NEXT_VERSION}.dev
```
[pypi]: https://pypi.org/project/jupyterhub/
[jupyterhub/autodoc-traits]: https://github.com/jupyterhub/autodoc-traits
[github-activity]: https://github.com/executablebooks/github-activity
[ci system]: https://github.com/jupyterhub/autodoc-traits/actions/workflows/release.yaml
|