|
1 | 1 | How to release |
2 | 2 | -------------- |
3 | 3 |
|
4 | | -- Update CHANGELOG.rst |
5 | | -- bump version (YYYY.MM) in pyproject.toml |
6 | | -- commit |
7 | | -- push to check one last time if the tests pass github side. |
8 | | -- tag it (YYYY.MM). |
9 | | -- build (``python -m build``) |
10 | | -- Test it (in:file:`cpython/Doc` run |
11 | | - ``./venv/bin/pip install ../../python-docs-theme/dist/python-docs-theme-2021.8.tar.gz`` |
12 | | - then build the doc using ``make html``). |
13 | | -- upload it: ``twine upload dist/*``. |
14 | | -- push the tag (``git push --tags``) |
15 | | - |
| 4 | +- Update ``CHANGELOG.rst`` |
| 5 | +- Bump version (YYYY.MM) in ``pyproject.toml`` |
| 6 | +- Commit |
| 7 | +- Push to check tests pass on |
| 8 | + `GitHub Actions<https://github.com/python/python-docs-theme/actions>`__ |
| 9 | +- Go to https://github.com/python/python-docs-theme/releases |
| 10 | +- Click "Draft a new release" |
| 11 | +- Click "Choose a tag" |
| 12 | +- Type the next YYYY.MM version (no leading zero) and |
| 13 | + select "**Create new tag: YYYY.MM** on publish" |
| 14 | +- Leave the "Release title" blank (it will be autofilled) |
| 15 | +- Click "Generate release notes" and amend as required |
| 16 | +- Click "Publish release" |
| 17 | +- Check the tagged `GitHub Actions build<https://github.com/python/python-docs-theme/actions/workflows/pypi-package.yml>`__ |
| 18 | + has deployed to `PyPI<https://pypi.org/project/python-docs-theme/#history>`__ |
16 | 19 |
|
17 | 20 | Makefile usage |
18 | 21 | -------------- |
|