|
| 1 | +# Release instructions |
| 2 | + |
| 3 | +This page contains the steps to make a release and some helpful resources to get you started. |
| 4 | + |
| 5 | +Create an issue and copy/paste the steps below to release a new version. Close the issue when it is done. |
| 6 | + |
| 7 | +These steps should be taken in order to create a new release![^release-refs] |
| 8 | + |
| 9 | +```md |
| 10 | +**Double check for quality-control** |
| 11 | + |
| 12 | +- [ ] There are no [open issues with a `impact: block-release` label](https://github.com/pydata/pydata-sphinx-theme/labels/impact%3A%20block-release) |
| 13 | + |
| 14 | +**Prepare the codebase for a new version** |
| 15 | + |
| 16 | +- [ ] Bump `__version__` in [`__init__.py`](https://github.com/pydata/pydata-sphinx-theme/blob/main/src/pydata_sphinx_theme/__init__.py#L16) |
| 17 | +- [ ] Update our [version switcher `.json` file](https://github.com/pydata/pydata-sphinx-theme/blob/main/docs/_static/switcher.json) with the new version |
| 18 | +- [ ] Make a release commit: `git commit -m 'bump: 0.1.9 → 0.2.0'` |
| 19 | +- [ ] Push the RLS commit `git push upstream main` |
| 20 | +- [ ] If a **release candidate** is needed, tick this box when we're now ready for a full release. |
| 21 | + |
| 22 | +**Make the release** |
| 23 | + |
| 24 | +- [ ] [Start a new GitHub release](https://github.com/pandas-dev/pydata-sphinx-theme/releases/new) |
| 25 | + - Call the release the current version, e.g. `v0.2.0` |
| 26 | + - In the **`Choose a Tag:`** dropdown, type in the release name (e.g., `v0.2.0`) and click "Create new tag" |
| 27 | + - In the **`Target:`** dropdown, pin it to the release commit that you've just pushed. |
| 28 | + - Generate the automatic release notes, eventually manually specify the previous version (useful when several release candidate have been made) |
| 29 | +- [ ] Confirm that the release completed |
| 30 | + - [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). |
| 31 | + - [The PyPI version is updated](https://pypi.org/project/pydata-sphinx-theme/) |
| 32 | +- [ ] Hide the previous patch version build in the RDT interface if needed. |
| 33 | +- [ ] Celebrate, you're done! |
| 34 | + |
| 35 | +[^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. |
| 36 | +``` |
0 commit comments