diff options
| author | Adam Turner <9087854+aa-turner@users.noreply.github.com> | 2022-09-24 21:58:10 +0100 |
|---|---|---|
| committer | Adam Turner <9087854+aa-turner@users.noreply.github.com> | 2022-09-24 21:59:18 +0100 |
| commit | 0273e68974e16e7805251eef5601773354208b37 (patch) | |
| tree | 861be856db8bd20132993e52751444600f58a0fb /utils | |
| parent | 68dd1b12e266834cac749b1d752b472938ce7408 (diff) | |
| download | sphinx-git-0273e68974e16e7805251eef5601773354208b37.tar.gz | |
Update release-checklist tagging guidance
Diffstat (limited to 'utils')
| -rw-r--r-- | utils/release-checklist | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/utils/release-checklist b/utils/release-checklist index 0d1733229..febbbae56 100644 --- a/utils/release-checklist +++ b/utils/release-checklist @@ -14,7 +14,7 @@ for stable releases * ``twine upload dist/Sphinx-* --sign --identity [your GPG key]`` * open https://pypi.org/project/Sphinx/ and check there are no obvious errors * ``sh utils/bump_docker.sh X.Y.Z`` -* ``git tag vX.Y.Z`` +* ``git tag vX.Y.Z -m "Sphinx X.Y.Z"`` * ``python utils/bump_version.py --in-develop X.Y.Zb0`` (ex. 1.5.3b0) * Check diff by ``git diff`` * ``git commit -am 'Bump version'`` @@ -37,7 +37,7 @@ for first beta releases * ``python -m build .`` * ``twine upload dist/Sphinx-* --sign --identity [your GPG key]`` * open https://pypi.org/project/Sphinx/ and check there are no obvious errors -* ``git tag vX.Y.0b1`` +* ``git tag vX.Y.0b1 -m "Sphinx X.Y.0b1"`` * ``python utils/bump_version.py --in-develop X.Y.0b2`` (ex. 1.6.0b2) * Check diff by ``git diff`` * ``git commit -am 'Bump version'`` @@ -65,7 +65,7 @@ for other beta releases * ``python -m build .`` * ``twine upload dist/Sphinx-* --sign --identity [your GPG key]`` * open https://pypi.org/project/Sphinx/ and check there are no obvious errors -* ``git tag vX.Y.0bN`` +* ``git tag vX.Y.0bN -m "Sphinx X.Y.0bN"`` * ``python utils/bump_version.py --in-develop X.Y.0bM`` (ex. 1.6.0b3) * Check diff by `git diff`` * ``git commit -am 'Bump version'`` @@ -91,7 +91,7 @@ for major releases * ``twine upload dist/Sphinx-* --sign --identity [your GPG key]`` * open https://pypi.org/project/Sphinx/ and check there are no obvious errors * ``sh utils/bump_docker.sh X.Y.Z`` -* ``git tag vX.Y.0`` +* ``git tag vX.Y.0 -m "Sphinx X.Y.0"`` * ``python utils/bump_version.py --in-develop X.Y.1b0`` (ex. 1.6.1b0) * Check diff by ``git diff`` * ``git commit -am 'Bump version'`` @@ -101,7 +101,7 @@ for major releases * ``git push origin master`` * open https://github.com/sphinx-doc/sphinx/settings/branches and make ``A.B`` branch *not* protected * ``git checkout A.B`` (checkout old stable) -* Run ``git tag A.B`` to paste a tag instead branch +* Run ``git tag A.B -m "Sphinx A.B"`` to paste a tag instead branch * Run ``git push origin :A.B --tags`` to remove old stable branch * open https://readthedocs.org/dashboard/sphinx/versions/ and enable the released version * Add new version/milestone to tracker categories |