-
Notifications
You must be signed in to change notification settings - Fork 62
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
18 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,16 @@ | ||
Steps to take when releasing a new version: | ||
* Bump version number and enter current date in `mph/__init__.py`. | ||
* Add the release notes to `docs/releases.md`. | ||
* Add a dedicated commit for the version bump. | ||
* Add the release notes for this version in the same commit. | ||
* Tag the commit with the version number, for example: `git tag -a v1.0.2`. | ||
* Tag the commit with the version number, for example: `git tag -a v1.0.3`. | ||
* Enter the release notes as an annotation. | ||
* Push the commit (but not the tag): `git push origin main`. | ||
* Check that documentation built successfully on Read-the-Docs. | ||
* Activate, but hide, the build for the release tag on Read-the-Docs. | ||
* Publish to PyPI by running `deploy/publish.py`. | ||
* Check that meta information is correct on PyPI. | ||
* Then push the tag: `git push --tags`. | ||
* Force the `stable` branch to new release tag: `git branch -f stable`. | ||
* Same for the current documentation branch: `git branch -f 1.0`. | ||
* Push both branches upstream, e.g.: `git push origin stable`. | ||
* Activate, but hide, the build for the release tag on Read-the-Docs. | ||
* Create a new release on GitHub and add the release notes. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters