From 1d8b02ceebc8264a396b7a8dcbf65e222468238d Mon Sep 17 00:00:00 2001 From: Elliott Sales de Andrade Date: Wed, 13 Sep 2023 16:48:22 -0400 Subject: [PATCH 1/3] DOC: Update docs for new automated release procedure --- README.rst | 30 +++++++++++++----------------- 1 file changed, 13 insertions(+), 17 deletions(-) diff --git a/README.rst b/README.rst index a0c1458..bc76bdc 100644 --- a/README.rst +++ b/README.rst @@ -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 +`_ +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 - $ 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 +`_. Update the required ``mpl-sphinx-theme`` version in the following files: @@ -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 `_ -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 `_ -for the new ``x.y.z`` release will automatically be opened by conda-forge bots. From 0dd03fefdae592e61d830c27362684ddf1422d6b Mon Sep 17 00:00:00 2001 From: Elliott Sales de Andrade Date: Wed, 13 Sep 2023 16:48:57 -0400 Subject: [PATCH 2/3] REL: 3.8.0 Bump version to 3.8.0 final. --- mpl_sphinx_theme/_version.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mpl_sphinx_theme/_version.py b/mpl_sphinx_theme/_version.py index 5b2bc87..b4ba1b2 100644 --- a/mpl_sphinx_theme/_version.py +++ b/mpl_sphinx_theme/_version.py @@ -5,4 +5,4 @@ # Distributed under the terms of the Modified BSD License. version_info = (3, 8, 0) -__version__ = ".".join(map(str, version_info)) + "rc1" +__version__ = ".".join(map(str, version_info)) From cca8581fa94588d89639a3aa9f074b28a758e98d Mon Sep 17 00:00:00 2001 From: Elliott Sales de Andrade Date: Wed, 13 Sep 2023 16:52:21 -0400 Subject: [PATCH 3/3] MNT: Prepare for next release --- mpl_sphinx_theme/_version.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mpl_sphinx_theme/_version.py b/mpl_sphinx_theme/_version.py index b4ba1b2..999c945 100644 --- a/mpl_sphinx_theme/_version.py +++ b/mpl_sphinx_theme/_version.py @@ -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)) +version_info = (3, 8, 1) +__version__ = ".".join(map(str, version_info)) + "dev0"