Skip to content

Commit

Permalink
Merge pull request #158 from python/update-release-checklist
Browse files Browse the repository at this point in the history
  • Loading branch information
hugovk authored Oct 6, 2023
2 parents 58bed3e + f738dc0 commit be0e655
Showing 1 changed file with 15 additions and 12 deletions.
27 changes: 15 additions & 12 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,21 @@
How to release
--------------

- Update CHANGELOG.rst
- bump version (YYYY.MM) in pyproject.toml
- commit
- push to check one last time if the tests pass github side.
- tag it (YYYY.MM).
- build (``python -m build``)
- Test it (in :file:`cpython/Doc` run
``./venv/bin/pip install ../../python-docs-theme/dist/python-docs-theme-2021.8.tar.gz``
then build the doc using ``make html``).
- upload it: ``twine upload dist/*``.
- push the tag (``git push --tags``)

- Update ``CHANGELOG.rst``
- Bump version (YYYY.MM) in ``pyproject.toml``
- Commit
- Push to check tests pass on
`GitHub Actions <https://github.com/python/python-docs-theme/actions>`__
- Go to https://github.com/python/python-docs-theme/releases
- Click "Draft a new release"
- Click "Choose a tag"
- Type the next YYYY.MM version (no leading zero) and
select "**Create new tag: YYYY.MM** on publish"
- Leave the "Release title" blank (it will be autofilled)
- Click "Generate release notes" and amend as required
- Click "Publish release"
- Check the tagged `GitHub Actions build <https://github.com/python/python-docs-theme/actions/workflows/pypi-package.yml>`__
has deployed to `PyPI <https://pypi.org/project/python-docs-theme/#history>`__

Makefile usage
--------------
Expand Down

0 comments on commit be0e655

Please sign in to comment.