Skip to content

Release checklist

Chris Holdgraf edited this page Apr 21, 2020 · 25 revisions

Release instructions

the pydata-sphinx-theme follows semantic version numbers. Here are the steps to release a new version:

Release instructions from [the release checklist wiki](https://github.com/pandas-dev/pydata-sphinx-theme/wiki/Release-checklist).

## Pre-requisites
- [ ] Ensure that you have [`twine` installed](https://pypi.org/project/twine/)
- [ ] [Create a new issue](https://github.com/pandas-dev/pydata-sphinx-theme/issues/new/choose) to track the release and copy this list into it. Use this as a checklist for your release.

## Version bump
- [ ] 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``

## Create wheels and publish to PyPI
- [ ] ``python setup.py sdist``
- [ ] ``python setup.py bdist_wheel --universal``
- [ ] Upload to PyPI [using `twine`](https://pypi.org/project/twine/): ``twine upload dist/*``

## Confirm uploads
(wait a few minutes to let the package pages update)
- [ ] Confirm that [the PyPI version is updated](https://pypi.org/project/pydata-sphinx-theme/)
- [ ] Confirm that [the conda-forge version](https://anaconda.org/conda-forge/pydata-sphinx-theme) is updated automatically after uploading to PyPI

## GitHub release
- [ ] [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`
- [ ] Add some simple release notes. If you wish, use [`github-activity` to generate a changelog](https://github.com/choldgraf/github-activity).

## Update master for new dev version
- [ ] Bump the [``__init__.py`` ``__version__``](https://github.com/pandas-dev/pydata-sphinx-theme/blob/master/pydata_sphinx_theme/__init__.py#L11) and add `dev0` to it. e.g.: `v0.2.1dev0`.
- [ ] Push to master.
- [ ] Celebrate, you're done!
Clone this wiki locally