-
Notifications
You must be signed in to change notification settings - Fork 327
Release checklist
Chris Holdgraf edited this page Mar 25, 2022
·
25 revisions
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.
- [ ] Bump `__version__` in [``__init__.py``](https://github.com/pydata/pydata-sphinx-theme/blob/38dadd72535da443163783dc9e5ff2ec382963f5/src/pydata_sphinx_theme/__init__.py#L16).
- 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.
- [ ] 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`
- [ ] 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)
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`.
- [ ] Confirm that [this github action job](https://github.com/pandas-dev/pydata-sphinx-theme/blob/master/.github/workflows/tests.yml#L66) has completed successfully in the [actions tab](https://github.com/pandas-dev/pydata-sphinx-theme/actions)
- [ ] Confirm that [the PyPI version is updated](https://pypi.org/project/pydata-sphinx-theme/)
- [ ] Celebrate, you're done!