22
33.. _release-guide :
44
5- ===============
6- Release Guide
7- ===============
5+ =============
6+ Release Guide
7+ =============
88
99
1010.. admonition :: This document is only relevant for Matplotlib release managers.
1717 This assumes that a read-only remote for the canonical repository is
1818 ``remote `` and a read/write remote is ``DANGER ``
1919
20- All Releases
21- ============
2220
2321.. _release-testing :
2422
2523Testing
26- -------
24+ =======
2725
2826We use `Travis CI <https://travis-ci.org/matplotlib/matplotlib >`__ for
2927continuous integration. When preparing for a release, the final
@@ -48,7 +46,7 @@ is currently broken::
4846.. _release_ghstats :
4947
5048GitHub Stats
51- ------------
49+ ============
5250
5351
5452We automatically extract GitHub issue, PRs, and authors from GitHub via the
@@ -88,23 +86,23 @@ most common issue is ``*`` which is interpreted as unclosed markup).
8886.. _release_chkdocs :
8987
9088Update and Validate the Docs
91- ----------------------------
89+ ============================
9290
9391Merge ``*-doc `` branch
94- ^^^^^^^^^^^^^^^^^^^^^^
92+ ----------------------
9593
9694Merge the most recent 'doc' branch (e.g., ``v3.2.0-doc ``) into the branch you
9795are going to tag on and delete the doc branch on GitHub.
9896
9997Update supported versions in Security Policy
100- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
98+ --------------------------------------------
10199
102100When making major or minor releases, update the supported versions in the
103101Security Policy in :file: `SECURITY.md `. Commonly, this may be one or two
104102previous minor releases, but is dependent on release managers.
105103
106104Update "What's New" and "API changes"
107- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
105+ -------------------------------------
108106
109107Before tagging major and minor releases, the "what's new" and "API changes"
110108listings should be updated. This is not needed for micro releases.
@@ -126,7 +124,7 @@ Similarly for the "API changes",
126124In both cases step 3 will have to be un-done right after the release.
127125
128126Verify that docs build
129- ^^^^^^^^^^^^^^^^^^^^^^
127+ ----------------------
130128
131129Finally, make sure that the docs build cleanly ::
132130
@@ -150,7 +148,7 @@ CI, this should only flag failed external links.
150148.. _release_tag :
151149
152150Create release commit and tag
153- -----------------------------
151+ =============================
154152
155153To create the tag, first create an empty commit with a very terse set of the release notes
156154in the commit message ::
@@ -219,7 +217,7 @@ On this branch un-comment the globs from :ref:`release_chkdocs`. And then ::
219217.. _release_DOI :
220218
221219Release Management / DOI
222- ------------------------
220+ ========================
223221
224222Via the `GitHub UI
225223<https://github.com/matplotlib/matplotlib/releases> `__, turn the newly
@@ -247,7 +245,7 @@ to :file:`tools/cache_zenodo_svg.py`, and the changes to
247245.. _release_bld_bin :
248246
249247Building binaries
250- -----------------
248+ =================
251249
252250We distribute macOS, Windows, and many Linux wheels as well as a source tarball
253251via PyPI. Most builders should trigger automatically once the tag is pushed to
@@ -286,7 +284,7 @@ This can be done ahead of collecting all of the binaries and uploading to pypi.
286284.. _release_upload_bin :
287285
288286Make distribution and upload to PyPI
289- ------------------------------------
287+ ====================================
290288
291289Once you have collected all of the wheels (expect this to take about a
292290day), generate the tarball ::
@@ -311,7 +309,7 @@ Congratulations, you have now done the second scariest part!
311309.. _release_docs :
312310
313311Build and Deploy Documentation
314- ------------------------------
312+ ==============================
315313
316314To build the documentation you must have the tagged version installed, but
317315build the docs from the ``ver-doc `` branch. An easy way to arrange this is::
@@ -365,7 +363,7 @@ and update the live web page (remember to clear your browser cache).
365363
366364
367365Announcing
368- ----------
366+ ==========
369367
370368The final step is to announce the release to the world. A short
371369version of the release notes along with acknowledgments should be sent to
0 commit comments