Skip to content

Prepare 3.8.0 release #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 13 additions & 17 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,18 +49,25 @@ The built html pages can be found in ``doc/_build/html/``
Releasing
---------

Manually for now... see the todo below for how we hope to eventually do it
automagically.
This project `uses GitHub Actions
<https://github.com/matplotlib/mpl-sphinx-theme/blob/main/.github/workflows/release.yml>`_
to automatically push a new release to PyPI whenever a release is made.

For example, to release a new ``3.9.0`` version of ``mpl-sphinx-theme``:

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

.. code-block::

$ git checkout <commit-hash>
$ git tag -a x.y.z -m 'Version x.y.z'
$ git push upstream main --tags
$ python -m build -s -w
$ twine upload dist/mpl_sphinx_theme-x.y.z*
$ git tag -s -a v3.9.0 -m 'REL: 3.9.0'
$ git push upstream --tags

Finally, `turn the tag into a GitHub release
<https://github.com/matplotlib/mpl-sphinx-theme/releases/new>`_.

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

Expand All @@ -69,14 +76,3 @@ Update the required ``mpl-sphinx-theme`` version in the following files:
* matplotlib/mpl-third-party: docs/requirements.txt
* matplotlib/governance: requirements-doc.txt
* matplotlib/mpl-gui: requirements-doc.txt

TODO: This project `uses GitHub Actions <https://github.com/matplotlib/mpl-sphinx-theme/blob/main/.github/workflows/publish-pypi.yml>`_
to automatically push a new release to PyPI whenever
a git tag is pushed. For example, to release a new ``x.y.z`` version of
``mpl-sphinx-theme``, checkout the commit you would like to release,
add a git tag, and push the tag to the ``main`` branch of the
``matplotlib/mpl-sphinx-theme`` repository:

TODO: After a new release is published on PyPI, a pull request to the ``mpl-sphinx-theme``
`conda-forge feedstock <https://github.com/conda-forge/mpl-sphinx-theme-feedstock>`_
for the new ``x.y.z`` release will automatically be opened by conda-forge bots.
4 changes: 2 additions & 2 deletions mpl_sphinx_theme/_version.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@
# Copyright (c) Matplotlib developers.
# Distributed under the terms of the Modified BSD License.

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