Doc release guide #7635

tacaswell · Dec 18, 2016

I have been sitting on this for about a year...

This is a fleshed out version of the checklist I have been using for releases.

QuLogic · Dec 18, 2016

doc/devel/release_guide.rst

+
+In addition the following two tests should be run and manually inspected::
+
+   python unit/memleak_hawaii3.py``


Extra backticks.

QuLogic · Dec 18, 2016

doc/devel/release_guide.rst

+
+.. _release_ghstats:
+
+Github Stats


GitHub, everywhere.

QuLogic · Dec 18, 2016

doc/devel/release_guide.rst

+Github Stats
+------------
+
+We automatically extract github issue, PRs, and authors from the github via the API::


the github -> GitHub

QuLogic · Dec 18, 2016

doc/devel/release_guide.rst

-  at the root of the source tree.
+After the docs are built, check that all of the links, internal and external, are still
+valid.  We use ``linkchecker`` for this, which has not been ported to python3 yet.  You will
+need to create a python2 enviroment with ``requests==2.9.0`` and linkchecker ::


enviroment -> environment

QuLogic · Dec 18, 2016

doc/devel/release_guide.rst

-On the branch, do any additional testing you want to do, and then build
-binaries and source distributions for testing as release candidates.
+which will prompt you for your gpg key password and an annotation.
+For pre releases it is important to follow :pep:`440` so than the


than -> that

QuLogic · Dec 18, 2016

doc/devel/release_guide.rst

+  git checkout v2.0.0-doc
+  git clean -xfd
+  cd doc
+  pyhton make.py html latex -n 16


latex? Not pdf, like before?

other one is wrong.

Just noticed, pyhton -> python

QuLogic · Dec 18, 2016

doc/devel/release_guide.rst

+there are directories containing the documentation for older versions.
+The documentation for current master are built on travis and push to
+the `devdocs <https://github.com/matplotlib/devdocs/>`__ repository.
+These are available `matplotlib.org/devdocs


available at

QuLogic · Dec 18, 2016

doc/devel/release_guide.rst

+  cd ../matplotlib.github.com
+  mkdir 2.0.0
+  rsync -a ../matplotlib/doc/build/html/* 2.0.0
+  cp ../matplotlib/doc/build/html/Matplotlib.pdf 2.0.0


Is this path right? It seems like it would have been covered by the rsync.

QuLogic · Dec 18, 2016

doc/devel/release_guide.rst

-matplotlib-devel.  Final (non-release-candidate) versions should also
-be announced on python-announce.  Include a summary of highlights from
-the CHANGELOG and/or post the whole CHANGELOG since the last release.
+In addition, annoucments should be made on social networks (twitter,


annoucements -> announcements

QuLogic · Dec 18, 2016

tools/github_stats.py

-
+    print('.. _github-stats:')
+    print()
+    print('Github Stats')


NelleV · Dec 18, 2016

That patch has really no reason to target 2.0…

The patch looks good.

NelleV · Dec 18, 2016

doc/devel/release_guide.rst

-the CHANGELOG and/or post the whole CHANGELOG since the last release.
+In addition, announcements should be made on social networks (twitter,
+g+, FB).  For major release, `NumFOCUS <http://www.numfocus.org/>`__
+should be contacted for inclusion in their news letter and maybe to


newsletter is in one word.

QuLogic · Dec 18, 2016

doc/devel/release_guide.rst

+GitHub Stats
+------------
+
+We automatically extract GitHub issue, PRs, and authors from the GitHub via the API::


the GitHub -> GitHub

QuLogic · Dec 18, 2016

doc/devel/release_guide.rst

-    git tag -a v1.0.1rc1 a9f3f3a50745
+.. [#] The tarball that is provided by GitHub is produced using `git
+       archive <https://git-scm.com/docs/git-archive>`__.  We use
+       `versioneer <https://github.com/warner/python-versioneer>`__


versioneer is a bit of a red-herring; it's just the git archive process that produces the tag/branch info. I just tried it and now I see what you mean about it.

That is where the substitution is used though

QuLogic · Dec 18, 2016

doc/devel/release_guide.rst


-Then push the tags to the main repository::
+	 git archive v2.0.0 -o matplotlib-2.0.0.tar.gz --prefix=matplotlib-2.0.0/


The trailing slash in the prefix is very important!

QuLogic · Dec 18, 2016

doc/devel/release_guide.rst


-* We have a Makefile for the OS X builds in the mpl source dir
-  :file:`release/osx`, so use this to prepare the OS X releases.
+  git push DANGER v2.0.0-doc:v2.0.0-doc


I meant before the editing, but you've got that in there now.

QuLogic · Dec 18, 2016

doc/devel/release_guide.rst


-This will hide any previous releases automatically.
+If this is a final release the following downsteam packagers should be contacted:


I sort of like 'downsteam'...

QuLogic · Dec 18, 2016

doc/devel/release_guide.rst

+  git checkout v2.0.0-doc
+  git clean -xfd
+  cd doc
+  pyhton make.py html latex -n 16


Just noticed, pyhton -> python

QuLogic · Dec 18, 2016

I don't know what GitHub did to my review, but I think this covers everything (though I'd guess you'd know best, after all.)

tacaswell · Dec 19, 2016

I validated most of this today with the rc2 release, will update the final release sutff with 2.0.

NelleV · Dec 19, 2016

I deduce from your comment that this is still work in progress?

tacaswell · Dec 19, 2016

I would not be sad if this got merged (after fix the apparently invaild bash?), but also would not be sad if this sits a bit longer.

NelleV · Dec 19, 2016

I've relaunched the tests, and will merge once it is all green.

NelleV · Dec 19, 2016

You've got around 15 minutes to fix that invalid bash :)

tacaswell added 4 commits December 17, 2016 15:46

WIP: release guide

2416f47

DOC: continue to update release guide

356cc74

DOC: reduce need to manually touch gh stats

595f4a1

DOC: more work on release guide

032b355

tacaswell added the Documentation label Dec 18, 2016

tacaswell added this to the 2.0.1 (next bug fix release) milestone Dec 18, 2016

QuLogic reviewed Dec 18, 2016

View reviewed changes

DOC: lots of small fixes, add description of tarball issue

74721f7

tacaswell force-pushed the doc_release_guide branch from 392a4db to 74721f7 Compare December 18, 2016 15:53

NelleV approved these changes Dec 18, 2016

View reviewed changes

DOC: minor edits

56483c8

QuLogic reviewed Dec 18, 2016

View reviewed changes

DOC: more minor tweaks

e9b8661

NelleV changed the title ~~Doc release guide~~ [MRG+1] Doc release guide Dec 19, 2016

tacaswell added 2 commits December 19, 2016 09:59

DOC: remove tabs

705db7e

DOC: add missing '

cff006e

NelleV merged commit 25c4818 into matplotlib:v2.x Dec 19, 2016

tacaswell deleted the doc_release_guide branch December 19, 2016 16:01

QuLogic changed the title ~~[MRG+1] Doc release guide~~ Doc release guide Dec 19, 2016

QuLogic modified the milestones: 2.0 (style change major release), 2.0.1 (next bug fix release) Dec 19, 2016

tacaswell mentioned this pull request Oct 8, 2017

re-write release guide #3707

Closed

29 tasks


		In addition the following two tests should be run and manually inspected::

		python unit/memleak_hawaii3.py``


		Then push the tags to the main repository::
		git archive v2.0.0 -o matplotlib-2.0.0.tar.gz --prefix=matplotlib-2.0.0/


		This will hide any previous releases automatically.
		If this is a final release the following downsteam packagers should be contacted:

Search code, repositories, users, issues, pull requests...

Uh oh!

Doc release guide #7635

Doc release guide #7635

Uh oh!

Conversation

tacaswell commented Dec 18, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

NelleV commented Dec 18, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

QuLogic commented Dec 18, 2016

Uh oh!

tacaswell commented Dec 19, 2016

Uh oh!

NelleV commented Dec 19, 2016

Uh oh!

tacaswell commented Dec 19, 2016

Uh oh!

NelleV commented Dec 19, 2016

Uh oh!

NelleV commented Dec 19, 2016

Uh oh!

Uh oh!