Skip to content

Commit 7f20ba7

Browse files
authored
Merge pull request #77 from matplotlib/v3.8.x
Prepare 3.8.0 release
2 parents 2ed4649 + cca8581 commit 7f20ba7

File tree

2 files changed

+15
-19
lines changed

2 files changed

+15
-19
lines changed

README.rst

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -49,18 +49,25 @@ The built html pages can be found in ``doc/_build/html/``
4949
Releasing
5050
---------
5151

52-
Manually for now... see the todo below for how we hope to eventually do it
53-
automagically.
52+
This project `uses GitHub Actions
53+
<https://github.com/matplotlib/mpl-sphinx-theme/blob/main/.github/workflows/release.yml>`_
54+
to automatically push a new release to PyPI whenever a release is made.
55+
56+
For example, to release a new ``3.9.0`` version of ``mpl-sphinx-theme``:
5457

5558
- be sure to edit `mpl_sphinx_theme/_version.py`
59+
- checkout the commit you would like to release
60+
- add a git tag
61+
- push the tag to the ``matplotlib/mpl-sphinx-theme`` repository
5662

5763
.. code-block::
5864
5965
$ git checkout <commit-hash>
60-
$ git tag -a x.y.z -m 'Version x.y.z'
61-
$ git push upstream main --tags
62-
$ python -m build -s -w
63-
$ twine upload dist/mpl_sphinx_theme-x.y.z*
66+
$ git tag -s -a v3.9.0 -m 'REL: 3.9.0'
67+
$ git push upstream --tags
68+
69+
Finally, `turn the tag into a GitHub release
70+
<https://github.com/matplotlib/mpl-sphinx-theme/releases/new>`_.
6471

6572
Update the required ``mpl-sphinx-theme`` version in the following files:
6673

@@ -69,14 +76,3 @@ Update the required ``mpl-sphinx-theme`` version in the following files:
6976
* matplotlib/mpl-third-party: docs/requirements.txt
7077
* matplotlib/governance: requirements-doc.txt
7178
* matplotlib/mpl-gui: requirements-doc.txt
72-
73-
TODO: This project `uses GitHub Actions <https://github.com/matplotlib/mpl-sphinx-theme/blob/main/.github/workflows/publish-pypi.yml>`_
74-
to automatically push a new release to PyPI whenever
75-
a git tag is pushed. For example, to release a new ``x.y.z`` version of
76-
``mpl-sphinx-theme``, checkout the commit you would like to release,
77-
add a git tag, and push the tag to the ``main`` branch of the
78-
``matplotlib/mpl-sphinx-theme`` repository:
79-
80-
TODO: After a new release is published on PyPI, a pull request to the ``mpl-sphinx-theme``
81-
`conda-forge feedstock <https://github.com/conda-forge/mpl-sphinx-theme-feedstock>`_
82-
for the new ``x.y.z`` release will automatically be opened by conda-forge bots.

mpl_sphinx_theme/_version.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@
44
# Copyright (c) Matplotlib developers.
55
# Distributed under the terms of the Modified BSD License.
66

7-
version_info = (3, 8, 0)
8-
__version__ = ".".join(map(str, version_info)) + "rc1"
7+
version_info = (3, 8, 1)
8+
__version__ = ".".join(map(str, version_info)) + "dev0"

0 commit comments

Comments
 (0)