Skip to content

Commit cd337d2

Browse files
authored
Update release instructions for automated PyPI release (#12)
* Update release instructions for automated PyPI release Signed-off-by: Felix Claessen <30658763+Flix6x@users.noreply.github.com> * Add clarifying note Signed-off-by: Felix Claessen <30658763+Flix6x@users.noreply.github.com> * Format PyPI Signed-off-by: Felix Claessen <30658763+Flix6x@users.noreply.github.com> --------- Signed-off-by: Felix Claessen <30658763+Flix6x@users.noreply.github.com>
1 parent e22f8fe commit cd337d2

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

RELEASE.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,11 +76,13 @@ For a MINOR or MAJOR release:
7676
- (PATCH) `git checkout` the patch release branch, backport the change log updates, and `git push` again
7777
- Add the version tag: `git tag -s -a v<major>.<minor>.<patch> -m ""`
7878
- `git push --tags`
79-
- [ ] Check if the documentation builds on [readthedocs.org](https://readthedocs.org/projects/flexmeasures/builds/) (login via Github)
79+
- [ ] [GitHub Actions](https://github.com/FlexMeasures/flexmeasures/actions)
80+
- [ ] Check your [GitHub notifications](https://github.com/notifications) for an approval request to release to PyPI (or ask one of the maintainers of the `pypi` environment of the FlexMeasures repository on GitHub)
81+
- [ ] Check whether the new release made it to [PyPI](https://pypi.org/p/flexmeasures)
82+
- [ ] Check if the documentation builds on [readthedocs.org](https://readthedocs.org/projects/flexmeasures/builds/) (login via Github)
8083
- [ ] Create [a release on GitHub](https://github.com/FlexMeasures/flexmeasures/releases) based on the new tag (you can copy the title from your blog post and also paste the change log notes in there; the "Generate release notes" button is also cool; code assets are added automatically)
8184
- [ ] (MINOR or MAJOR) Publish the blog post in Publii ("Sync your website") - if you need a Github token, you can generate one [like this](https://github.com/settings/tokens/new?scopes=public_repo,repo_deployment&description=Token%20for%20Deployment%20to%20GitHub%20Pages). Other Server settings for [Publii under Github Pages](https://getpublii.com/docs/host-static-website-github-pages.html): "Website URL":"flexmeasures.io", "API Server": "api.github.com", "Username": "FlexMeasures", "Repository": "website".
82-
- [ ] Release to Pypi
83-
- Run `./to_pypi.sh` # Credentials in Seita's keepass store (in the "PyPi" card's description), use `__token__` as username and the access token as password
85+
- [ ] Test PyPI release
8486
- Test (in some fresh context) if pip installs the fresh version:
8587
- `python3 -m venv testing-fm-latest; source testing-fm-latest/bin/activate`
8688
- `pip install --upgrade flexmeasures` # should download & install new version

0 commit comments

Comments
 (0)