Skip to content

Commit d70dd10

Browse files
authored
Update release checklist
1 parent 58bed3e commit d70dd10

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

CONTRIBUTING.rst

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
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 and
13+
select "**Create new tag: YYYY.MM** on publish"
14+
- Click "Generate release notes" and amend as required
15+
- Click "Publish release"
16+
- Check the tagged `GitHub Actions build <https://github.com/python/python-docs-theme/actions/workflows/pypi-package.yml>`__
17+
has deployed to `PyPI <https://pypi.org/project/python-docs-theme/#history>`__
1618

1719
Makefile usage
1820
--------------

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy