Skip to content

Update release instructions for automated PyPI release #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Flix6x merged 3 commits into from
Aug 11, 2025
Merged

Update release instructions for automated PyPI release #12

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0636afa
Update release instructions for automated PyPI release
Flix6x Aug 11, 2025
4ff4ec1
Add clarifying note
Flix6x Aug 11, 2025
57725bd
Format PyPI
Flix6x Aug 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,11 +76,13 @@ For a MINOR or MAJOR release:
- (PATCH) `git checkout` the patch release branch, backport the change log updates, and `git push` again
- Add the version tag: `git tag -s -a v<major>.<minor>.<patch> -m ""`
- `git push --tags`
- [ ] Check if the documentation builds on [readthedocs.org](https://readthedocs.org/projects/flexmeasures/builds/) (login via Github)
- [ ] [GitHub Actions](https://github.com/FlexMeasures/flexmeasures/actions)
- [ ] 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)
- [ ] Check whether the new release made it to [PyPI](https://pypi.org/p/flexmeasures)
- [ ] Check if the documentation builds on [readthedocs.org](https://readthedocs.org/projects/flexmeasures/builds/) (login via Github)
- [ ] 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)
- [ ] (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".
- [ ] Release to Pypi
- 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
- [ ] Test PyPI release
- Test (in some fresh context) if pip installs the fresh version:
- `python3 -m venv testing-fm-latest; source testing-fm-latest/bin/activate`
- `pip install --upgrade flexmeasures` # should download & install new version
Expand Down