From 0636afa3650c9067ac584d82073962803ad62ea4 Mon Sep 17 00:00:00 2001 From: Felix Claessen <30658763+Flix6x@users.noreply.github.com> Date: Mon, 11 Aug 2025 12:13:18 +0200 Subject: [PATCH 1/3] Update release instructions for automated PyPI release Signed-off-by: Felix Claessen <30658763+Flix6x@users.noreply.github.com> --- RELEASE.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index 8b8e19a..dd7d9aa 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -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.. -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 + - [ ] 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 From 4ff4ec1460770f883a4210bb9c9713622b07fe5e Mon Sep 17 00:00:00 2001 From: Felix Claessen <30658763+Flix6x@users.noreply.github.com> Date: Mon, 11 Aug 2025 12:15:57 +0200 Subject: [PATCH 2/3] Add clarifying note Signed-off-by: Felix Claessen <30658763+Flix6x@users.noreply.github.com> --- RELEASE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RELEASE.md b/RELEASE.md index dd7d9aa..be40dd4 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -77,7 +77,7 @@ For a MINOR or MAJOR release: - Add the version tag: `git tag -s -a v.. -m ""` - `git push --tags` - [ ] [GitHub Actions](https://github.com/FlexMeasures/flexmeasures/actions) - - [ ] Check your [GitHub notifications](https://github.com/notifications) for an approval request to release to PyPI + - [ ] 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) From 57725bd3d24de1843561e79a2a72600aafb40df8 Mon Sep 17 00:00:00 2001 From: Felix Claessen <30658763+Flix6x@users.noreply.github.com> Date: Mon, 11 Aug 2025 12:16:28 +0200 Subject: [PATCH 3/3] Format PyPI Signed-off-by: Felix Claessen <30658763+Flix6x@users.noreply.github.com> --- RELEASE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RELEASE.md b/RELEASE.md index be40dd4..5d393d7 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -82,7 +82,7 @@ For a MINOR or MAJOR release: - [ ] 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". -- [ ] Test Pypi release +- [ ] 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