Skip to content

Update release checklist #158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 6, 2023
Merged

Update release checklist #158

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d70dd10
Update release checklist
hugovk Oct 4, 2023
f738dc0
Clarify checklist
hugovk Oct 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 15 additions & 12 deletions CONTRIBUTING.rst
View file
Open in desktop
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