Skip to content

Release checklist

Jump to bottom
Rambaud Pierrick edited this page Nov 29, 2023 · 24 revisions

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 `block-release` label](https://github.com/pydata/pydata-sphinx-theme/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Ablock-release)

**Prepare the codebase for a new version**

- [ ] Bump `__version__` in [``__init__.py``](https://github.com/pydata/pydata-sphinx-theme/blob/38dadd72535da443163783dc9e5ff2ec382963f5/src/pydata_sphinx_theme/__init__.py#L16)
- [ ] Update our version switcher `.json` file 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.
    - Add release notes in the field below (if it's a minor/major version bump)[^github-activity]
- [ ] Confirm that the release completed
    - [The `publish` github action job](https://github.com/pydata/pydata-sphinx-theme/blob/9665190a8a5fbde0de7e7fc6e3608f43de52ec23/.github/workflows/tests.yml#L164-L184) 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.

[^github-activity]: If you wish, use [`github-activity` to generate a changelog](https://github.com/choldgraf/github-activity), eg `github-activity pydata/pydata-sphinx-theme --since v0.2.2 --until v0.3.0`.
Clone this wiki locally