From d70dd100273e4992dd610786a2dc8219e2b99bcd Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Wed, 4 Oct 2023 18:30:59 +0300 Subject: [PATCH 1/2] Update release checklist --- CONTRIBUTING.rst | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 0b2fbd6..b0b4fa8 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,18 +1,20 @@ 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 `__ +- 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 and + select "**Create new tag: YYYY.MM** on publish" +- Click "Generate release notes" and amend as required +- Click "Publish release" +- Check the tagged `GitHub Actions build `__ + has deployed to `PyPI `__ Makefile usage -------------- From f738dc01fb2ce5f40ce495925a4c1aa01a045579 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Wed, 4 Oct 2023 21:40:32 +0300 Subject: [PATCH 2/2] Clarify checklist --- CONTRIBUTING.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index b0b4fa8..2533e96 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -9,8 +9,9 @@ How to release - 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 and +- 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 `__