Skip to content

Release checklist

Chris Holdgraf edited this page Oct 2, 2021 · 25 revisions

Release instructions

the pydata-sphinx-theme follows semantic version numbers.

As a guide, create an issue and copy/paste the steps below to release a new version. Close the issue when it is done.

- [ ] Remove `dev0` from the version in [``__init__.py`` ``__version__``](https://github.com/pandas-dev/pydata-sphinx-theme/blob/master/pydata_sphinx_theme/__init__.py#L11)
- [ ] Make a release commit: ``git commit -m 'RLS: v0.2.0'``
- [ ] Push the RLS commit ``git push upstream master``
- [ ] [Make a GitHub release](https://github.com/pandas-dev/pydata-sphinx-theme/releases/new)
  - [ ] Call the release the current version, e.g. `v0.2.0` and pin it to `master`
  - [ ] This will trigger [this github action job](https://github.com/pandas-dev/pydata-sphinx-theme/blob/master/.github/workflows/tests.yml#L66). Ensure that it completes in the [actions tab](https://github.com/pandas-dev/pydata-sphinx-theme/actions)
 After a few minutes, confirm that [the PyPI version is updated](https://pypi.org/project/pydata-sphinx-theme/)
  - [ ] If it's a minor/major versoin bump, add some simple release notes.
        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`).
- [ ] Bump the [``__init__.py`` ``__version__``](https://github.com/pydata/pydata-sphinx-theme/blob/master/pydata_sphinx_theme/__init__.py#L11) and add `dev0` to it. e.g.: `v0.2.1dev0`.
- [ ] Commit and push to master
      ```
      git commit -m "dev version bump"
      git push upstream master
      ```
- [ ] Celebrate, you're done!
Clone this wiki locally