Release checklist - pydata/pydata-sphinx-theme Wiki

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.

**Double check for quality-control**

- [ ] There are no more open issues in [the release milestone](https://github.com/pydata/pydata-sphinx-theme/milestones)
- [ ] 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)[^semantic-version]
- [ ] Update our version switcher `.json` file with the new version
- [ ] Make a release commit: ``git commit -m 'RLS: v0.2.0'``
- [ ] Push the RLS commit ``git push upstream master``

**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 `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)
- [ ] Confirm that [the PyPI version is updated](https://pypi.org/project/pydata-sphinx-theme/)
- [ ] Celebrate, you're done!

[^semantic-version]: Use [semantic versioning](https://semver.org/) to decide whether it's a major, minor, or patch bump. Before we have released `1.0`, treat minor versions as breaking releases, and patch versions as feature / patch releases.

[^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`.