blob: 5aabbcee12b861702b35e749ac856630a69cd54b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
|
Release checklist
=================
A stable release is a release where the minor or micro version parts are
incremented.
A major release is a release where the major version part is incremented.
Checks
------
* open "https://github.com/sphinx-doc/sphinx/actions?query=branch:master" and all tests has passed
* Run ``git fetch; git status`` and check that nothing has changed
Bump version
------------
for stable and major releases
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* ``python utils/bump_version.py X.Y.Z``
* Check diff by ``git diff``
* ``git commit -am 'Bump to X.Y.Z final'``
* ``git tag vX.Y.Z -m "Sphinx X.Y.Z"``
for beta releases
~~~~~~~~~~~~~~~~~
* ``python utils/bump_version.py X.Y.0bN``
* Check diff by ``git diff``
* ``git commit -am 'Bump to X.Y.0 betaN'``
* ``git tag vX.Y.0b1 -m "Sphinx X.Y.0bN"``
Build Sphinx
------------
* ``make clean``
* ``python -m build .``
* ``twine upload dist/Sphinx-*``
* open https://pypi.org/project/Sphinx/ and check for any obvious errors
for stable and major releases
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* ``sh utils/bump_docker.sh X.Y.Z``
Bump to next development version
--------------------------------
for stable and major releases
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* ``python utils/bump_version.py --in-develop X.Y.Z+1b0`` (ex. 1.5.3b0)
for beta releases
~~~~~~~~~~~~~~~~~
* ``python utils/bump_version.py --in-develop X.Y.0bN+1`` (ex. 1.6.0b2)
Commit version bump
-------------------
* Check diff by ``git diff``
* ``git commit -am 'Bump version'``
* ``git push origin master --tags``
Final steps
-----------
* Add new version/milestone to tracker categories
* Write announcement and send to sphinx-dev, sphinx-users and python-announce
|
