Skip to content

Commit be0e655

Browse files
authored
Merge pull request #158 from python/update-release-checklist
2 parents 58bed3e + f738dc0 commit be0e655

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

CONTRIBUTING.rst

+15-12
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,21 @@
11
How to release
22
--------------
33

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>`__
1619

1720
Makefile usage
1821
--------------

0 commit comments

Comments
 (0)