Merge pull request #158 from python/update-release-checklist

hugovk · web-flow · commit be0e65501b9a · 2023-10-06T07:05:48.000-06:00
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -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
 --------------
