From 94eae2c4f93fd5b46760eae4a78844e07e3b96f6 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Tue, 6 Feb 2018 23:19:25 +0900 Subject: [PATCH 1/2] Add procedures for beta and final releases --- utils/release-checklist | 105 ++++++++++++++++++++++++++++++++++------ 1 file changed, 90 insertions(+), 15 deletions(-) diff --git a/utils/release-checklist b/utils/release-checklist index fa537014f..4ef8092e6 100644 --- a/utils/release-checklist +++ b/utils/release-checklist @@ -1,19 +1,11 @@ Release checklist ================= +for stable releases +------------------- + * open https://travis-ci.org/sphinx-doc/sphinx/branches and check **X.Y** branch is green * Run `git status` and check nothing changed -* Update sphinx/locale/sphinx.pot if first major release (beta1) - - * Run `python setup.py extract_messages` - * Run `(cd sphinx/locale; tx push -s)` - -* Update sphinx/locale// files if final major release ... - - * Run `(cd sphinx/locale; tx pull -a -f)` - * Run `python setup.py compile_catalog` - * Run `git commit -am 'Update message catalogs'` - * `python utils/bump_version.py X.Y.Z` * Check diff by `git diff` * Edit CHANGES if empty section exists @@ -22,16 +14,99 @@ Release checklist * `python setup.py release bdist_wheel sdist upload --identity=[your key]` * open https://pypi.python.org/pypi/Sphinx and check there are no obvious errors * `git tag vX.Y.Z` -* Merge default into X.Y branch if final major release -* `git push origin X.Y --tags` -* open https://readthedocs.org/dashboard/sphinx/versions/ and enable the released version * `python utils/bump_version.py --in-develop X.Y.Zb0` (ex. 1.5.3b0) * Check diff by `git diff` * `git commit -am 'Bump version'` -* `git push origin X.Y` +* `git push origin X.Y --tags` * `git checkout master` * `git merge X.Y` * `git push origin master` * Update `sphinx-doc-translations `_ * Add new version/milestone to tracker categories * Write announcement and send to sphinx-dev, sphinx-users and python-announce + +for first beta releases +----------------------- + +* open https://travis-ci.org/sphinx-doc/sphinx/branches and check **master** branch is green +* Run `git status` and check nothing changed +* Run `python setup.py extract_messages` +* Run `(cd sphinx/locale; tx push -s)` +* `python utils/bump_version.py X.Y.0b1` +* Check diff by `git diff` +* Edit CHANGES if empty section exists +* `git commit -am 'Bump to X.Y.0 beta1'` +* `make clean` +* `python setup.py release bdist_wheel sdist upload --identity=[your key]` +* open https://pypi.python.org/pypi/Sphinx and check there are no obvious errors +* `git tag vX.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'` +* `git checkout -b X.Y` +* `git push origin X.Y --tags` +* `git checkout master` +* `git merge X.Y` +* `python utils/bump_version.py --in-develop A.B.0b0` (ex. 1.7.0b0) +* Check diff by `git diff` +* `git commit -am 'Bump version'` +* `git push origin master` +* Update `sphinx-doc-translations `_ +* Add new version/milestone to tracker categories +* Write announcement and send to sphinx-dev, sphinx-users and python-announce + +for other beta releases +----------------------- + +* open https://travis-ci.org/sphinx-doc/sphinx/branches and check **X.Y** branch is green +* Run `git status` and check nothing changed +* `python utils/bump_version.py X.Y.0bN` +* Check diff by `git diff` +* Edit CHANGES if empty section exists +* `git commit -am 'Bump to X.Y.0 betaN'` +* `make clean` +* `python setup.py release bdist_wheel sdist upload --identity=[your key]` +* open https://pypi.python.org/pypi/Sphinx and check there are no obvious errors +* `git tag vX.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'` +* `git push origin X.Y --tags` +* `git checkout master` +* `git merge X.Y` +* `git push origin master` +* Update `sphinx-doc-translations `_ +* Add new version/milestone to tracker categories +* Write announcement and send to sphinx-dev, sphinx-users and python-announce + +for major releases +------------------ + +* open https://travis-ci.org/sphinx-doc/sphinx/branches and check **X.Y** branch is green +* Run `git status` and check nothing changed +* Run `(cd sphinx/locale; tx pull -a -f)` +* Run `python setup.py compile_catalog` +* Run `git add sphinx` +* Run `git commit -am 'Update message catalogs'` +* `python utils/bump_version.py X.Y.0` +* Check diff by `git diff` +* Edit CHANGES if empty section exists +* `git commit -am 'Bump to X.Y.0 final'` +* `make clean` +* `python setup.py release bdist_wheel sdist upload --identity=[your key]` +* open https://pypi.python.org/pypi/Sphinx and check there are no obvious errors +* `git tag vX.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'` +* `git push origin X.Y --tags` +* `git checkout master` +* `git merge X.Y` +* `git push origin master` +* `git checkout A.B` (checkout old stable) +* Run `git tag 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 +* Update `sphinx-doc-translations `_ +* Add new version/milestone to tracker categories +* Write announcement and send to sphinx-dev, sphinx-users and python-announce From 7a92e3e40911375ca8c1030a6cdaf7a972693473 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Wed, 7 Feb 2018 10:49:46 +0900 Subject: [PATCH 2/2] Call git fetch before checking status --- utils/release-checklist | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/utils/release-checklist b/utils/release-checklist index 4ef8092e6..dff7e86ec 100644 --- a/utils/release-checklist +++ b/utils/release-checklist @@ -5,7 +5,7 @@ for stable releases ------------------- * open https://travis-ci.org/sphinx-doc/sphinx/branches and check **X.Y** branch is green -* Run `git status` and check nothing changed +* Run `git fetch; git status` and check nothing changed * `python utils/bump_version.py X.Y.Z` * Check diff by `git diff` * Edit CHANGES if empty section exists @@ -29,7 +29,7 @@ for first beta releases ----------------------- * open https://travis-ci.org/sphinx-doc/sphinx/branches and check **master** branch is green -* Run `git status` and check nothing changed +* Run `git fetch; git status` and check nothing changed * Run `python setup.py extract_messages` * Run `(cd sphinx/locale; tx push -s)` * `python utils/bump_version.py X.Y.0b1` @@ -59,7 +59,7 @@ for other beta releases ----------------------- * open https://travis-ci.org/sphinx-doc/sphinx/branches and check **X.Y** branch is green -* Run `git status` and check nothing changed +* Run `git fetch; git status` and check nothing changed * `python utils/bump_version.py X.Y.0bN` * Check diff by `git diff` * Edit CHANGES if empty section exists @@ -83,7 +83,7 @@ for major releases ------------------ * open https://travis-ci.org/sphinx-doc/sphinx/branches and check **X.Y** branch is green -* Run `git status` and check nothing changed +* Run `git fetch; git status` and check nothing changed * Run `(cd sphinx/locale; tx pull -a -f)` * Run `python setup.py compile_catalog` * Run `git add sphinx`