Repository navigation
Doc release guide - #7635
Merged
Merged
Doc release guide#7635
Conversation
QuLogic
reviewed
Dec 18, 2016
|
|
||
| In addition the following two tests should be run and manually inspected:: | ||
|
|
||
| python unit/memleak_hawaii3.py`` |
|
|
||
| .. _release_ghstats: | ||
|
|
||
| Github Stats |
| Github Stats | ||
| ------------ | ||
|
|
||
| We automatically extract github issue, PRs, and authors from the github via the API:: |
| 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 :: |
| 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 |
| git checkout v2.0.0-doc | ||
| git clean -xfd | ||
| cd doc | ||
| pyhton make.py html latex -n 16 |
| 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 |
| 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 |
Member
There was a problem hiding this comment.
Is this path right? It seems like it would have been covered by the rsync.
| 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, |
|
|
||
| print('.. _github-stats:') | ||
| print() | ||
| print('Github Stats') |
tacaswell
force-pushed
the
doc_release_guide
branch
from
December 18, 2016 15:53
392a4db to
74721f7
Compare
Member
|
That patch has really no reason to target 2.0… The patch looks good. |
NelleV
approved these changes
Dec 18, 2016
| 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 |
QuLogic
reviewed
Dec 18, 2016
| GitHub Stats | ||
| ------------ | ||
|
|
||
| We automatically extract GitHub issue, PRs, and authors from the GitHub via the API:: |
| 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>`__ |
Member
There was a problem hiding this comment.
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.
Member
Author
There was a problem hiding this comment.
That is where the substitution is used though
| To generate the file that GitHub does use :: | ||
|
|
||
| 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/ |
Member
There was a problem hiding this comment.
The trailing slash in the prefix is very important!
|
|
||
| * 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 |
Member
There was a problem hiding this comment.
I meant before the editing, but you've got that in there now.
QuLogic
reviewed
Dec 18, 2016
| <https://github.com/conda-forge/matplotlib-feedstock>`__ via pull request. | ||
|
|
||
| This will hide any previous releases automatically. | ||
| If this is a final release the following downsteam packagers should be contacted: |
Member
Author
There was a problem hiding this comment.
I sort of like 'downsteam'...
| git checkout v2.0.0-doc | ||
| git clean -xfd | ||
| cd doc | ||
| pyhton make.py html latex -n 16 |
Member
|
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.) |
Member
Author
|
I validated most of this today with the rc2 release, will update the final release sutff with 2.0. |
Member
|
I deduce from your comment that this is still work in progress? |
Member
Author
|
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. |
Member
|
I've relaunched the tests, and will merge once it is all green. |
Member
|
You've got around 15 minutes to fix that invalid bash :) |
QuLogic
modified the milestones:
2.0 (style change major release),
2.0.1 (next bug fix release)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.
Closes #3707