From f8a1e5ac4ed88b6a84598f72ec99ab61d3023bf9 Mon Sep 17 00:00:00 2001 From: Rambaud Pierrick <12rambau@users.noreply.github.com> Date: Thu, 4 Jan 2024 07:48:02 +0000 Subject: [PATCH 1/7] fix: update text and links --- RELEASE.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 RELEASE.md diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 000000000..87fa775d0 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,36 @@ +# Release instructions + +The `pydata-sphinx-theme` follows semantic version numbers. + +This page contains the steps to make a release and some helpful resources to get you started. + +Create an issue and copy/paste the steps below to release a new version. Close the issue when it is done. + +These steps should be taken in order to create a new release![^release-refs] + +**Double check for quality-control** + +- [ ] There are no [open issues with a `impact: block-release` label](https://github.com/pydata/pydata-sphinx-theme/labels/impact%3A%20block-release) + +**Prepare the codebase for a new version** + +- [ ] Bump `__version__` in [`__init__.py`](https://github.com/pydata/pydata-sphinx-theme/blob/main/src/pydata_sphinx_theme/__init__.py#L16) +- [ ] Update our [version switcher `.json` file](https://github.com/pydata/pydata-sphinx-theme/blob/main/docs/_static/switcher.json) with the new version +- [ ] Make a release commit: `git commit -m 'bump: 0.1.9 → 0.2.0'` +- [ ] Push the RLS commit `git push upstream main` +- [ ] If a **release candidate** is needed, tick this box when we're now ready for a full release. + +**Make the release** + +- [ ] [Start a new GitHub release](https://github.com/pandas-dev/pydata-sphinx-theme/releases/new) + - Call the release the current version, e.g. `v0.2.0` + - In the **`Choose a Tag:`** dropdown, type in the release name (e.g., `v0.2.0`) and click "Create new tag" + - In the **`Target:`** dropdown, pin it to the release commit that you've just pushed. + - Generate the automatic release notes, eventually manually specify the previous version (useful when several release candidate have been made) +- [ ] Confirm that the release completed + - [The `publish` github action job](https://github.com/pydata/pydata-sphinx-theme/blob/main/.github/workflows/publish.yml#L31) has completed successfully in the [actions tab](https://github.com/pydata/pydata-sphinx-theme/actions). + - [The PyPI version is updated](https://pypi.org/project/pydata-sphinx-theme/) +- [ ] Hide the previous patch version build in the RDT interface if needed. +- [ ] Celebrate, you're done! + +[^release-refs]: Taken from [the release checklist in our wiki](https://github.com/pydata/pydata-sphinx-theme/wiki/Release-checklist). See [the release documentation](https://pydata-sphinx-theme.readthedocs.io/en/latest/contribute/policies.html#release-policy) for an overview of release processes. From 69d7a55b0f24a61324349e09b48e09ae0b6e1743 Mon Sep 17 00:00:00 2001 From: Rambaud Pierrick <12rambau@users.noreply.github.com> Date: Thu, 4 Jan 2024 07:49:54 +0000 Subject: [PATCH 2/7] fix: add code highlight --- RELEASE.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/RELEASE.md b/RELEASE.md index 87fa775d0..9f9a67665 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -8,6 +8,7 @@ Create an issue and copy/paste the steps below to release a new version. Close t These steps should be taken in order to create a new release![^release-refs] +```md **Double check for quality-control** - [ ] There are no [open issues with a `impact: block-release` label](https://github.com/pydata/pydata-sphinx-theme/labels/impact%3A%20block-release) @@ -34,3 +35,4 @@ These steps should be taken in order to create a new release![^release-refs] - [ ] Celebrate, you're done! [^release-refs]: Taken from [the release checklist in our wiki](https://github.com/pydata/pydata-sphinx-theme/wiki/Release-checklist). See [the release documentation](https://pydata-sphinx-theme.readthedocs.io/en/latest/contribute/policies.html#release-policy) for an overview of release processes. +``` From a76fee6a4ea7cd87e73af26b4c12eea6220fa5cc Mon Sep 17 00:00:00 2001 From: Rambaud Pierrick <12rambau@users.noreply.github.com> Date: Thu, 4 Jan 2024 07:53:35 +0000 Subject: [PATCH 3/7] fix: wire correct file in our documentation --- docs/community/practices/release.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/community/practices/release.md b/docs/community/practices/release.md index 6b4617a40..4ea4809ee 100644 --- a/docs/community/practices/release.md +++ b/docs/community/practices/release.md @@ -19,7 +19,7 @@ Anybody is encouraged to make a new release if: - It has been more than a month since the last release. - OR a significant change has been made to our code that warrants a release. -- AND there are no open issues with a [{guilabel}`block-release`](https://github.com/pydata/pydata-sphinx-theme/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Ablock-release) label. +- AND there are no open issues with a [{guilabel}`impact: block-release`](https://github.com/pydata/pydata-sphinx-theme/labels/impact%3A%20block-release) label. ### Release candidates @@ -35,7 +35,7 @@ Follow these steps to make a release: - (optionally) **Create a [GitHub milestones](https://github.com/pydata/pydata-sphinx-theme/milestones)** to organize the issues that should be resolved as part of a new release. - **Decide if it's time** to make a release be reading [](releases:when) and decide if it is time for a release. -- **Copy the release checklist into a new issue**. We have [a release checklist in our wiki](https://github.com/pydata/pydata-sphinx-theme/wiki/Release-checklist#release-instructions). +- **Copy the [release checklist](https://github.com/pydata/pydata-sphinx-theme/blob/main/RELEASE.md) into a new issue**. - **Complete the checklist**. That's it! ## Choosing a version increment From 4e094e7670a43dc7c822a19c3a0ddf46e0716cf2 Mon Sep 17 00:00:00 2001 From: Rambaud Pierrick <12rambau@users.noreply.github.com> Date: Thu, 4 Jan 2024 14:28:55 +0000 Subject: [PATCH 4/7] chore: trigger CI From 3a0f311b41271d78eb9495f4d3fc4d12f6aa00df Mon Sep 17 00:00:00 2001 From: Rambaud Pierrick <12rambau@users.noreply.github.com> Date: Thu, 4 Jan 2024 22:19:33 +0100 Subject: [PATCH 5/7] remove mention of semantic versioning Co-authored-by: Daniel McCloy --- RELEASE.md | 1 - 1 file changed, 1 deletion(-) diff --git a/RELEASE.md b/RELEASE.md index 9f9a67665..209654c44 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -1,6 +1,5 @@ # Release instructions -The `pydata-sphinx-theme` follows semantic version numbers. This page contains the steps to make a release and some helpful resources to get you started. From 302936041056795d5af3150690a99a2691f8ff0f Mon Sep 17 00:00:00 2001 From: Rambaud Pierrick <12rambau@users.noreply.github.com> Date: Thu, 4 Jan 2024 21:58:14 +0000 Subject: [PATCH 6/7] refactor: lint --- RELEASE.md | 1 - 1 file changed, 1 deletion(-) diff --git a/RELEASE.md b/RELEASE.md index 209654c44..759dcb5eb 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -1,6 +1,5 @@ # Release instructions - This page contains the steps to make a release and some helpful resources to get you started. Create an issue and copy/paste the steps below to release a new version. Close the issue when it is done. From c1ef1525ea080bdc26b99587ab08e901eacbbd45 Mon Sep 17 00:00:00 2001 From: Rambaud Pierrick <12rambau@users.noreply.github.com> Date: Fri, 12 Jan 2024 18:59:01 +0100 Subject: [PATCH 7/7] Update RELEASE.md --- RELEASE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RELEASE.md b/RELEASE.md index 759dcb5eb..1abdf5fff 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -32,5 +32,5 @@ These steps should be taken in order to create a new release![^release-refs] - [ ] Hide the previous patch version build in the RDT interface if needed. - [ ] Celebrate, you're done! -[^release-refs]: Taken from [the release checklist in our wiki](https://github.com/pydata/pydata-sphinx-theme/wiki/Release-checklist). See [the release documentation](https://pydata-sphinx-theme.readthedocs.io/en/latest/contribute/policies.html#release-policy) for an overview of release processes. +[^release-refs]: Taken from [the release checklist](https://github.com/pydata/pydata-sphinx-theme/blob/main/RELEASE.md). See [the release documentation](https://pydata-sphinx-theme.readthedocs.io/en/latest/contribute/policies.html#release-policy) for an overview of release processes. ```