Release Process#
This guide documents the process for creating a release of watts
.
Step-by-step Directions#
To create a release, follow the steps below:
Create a new branch for the release (
release-x.x.x
).Check/update
CHANGELOG.md
to ensure that it lists all changes, additions, deprecations, and fixes since the last release.Add a new version entry in
doc/source/_static/switcher.json
.Update the version number in
pyproject.toml
andsrc/watts/__init__.py
.Commit the changes, push to your fork, and create a pull request.
Once the pull request is reviewed and merged, create and tag a release from the Releases tab on the GitHub repo.
GitHub Actions will automatically publish the release to PyPI (no action necessary).
Zenodo will automatically assign a DOI to the new release (no action necessary).
At this point, the release is complete but there are a few post-release steps needed:
Create a new branch with a name of your choosing.
Update the version number in
pyproject.toml
andsrc/watts/__init__.py
by incrementing the “release” number (the last of the three version components) and adding “-dev”.Add an
## [Unreleased]
section inCHANGELOG.md
.Update the version and release date in
.wci.yml
.Commit the changes, push to your fork, and create a pull request.