From e3fc578d44d4d2f40b462a10ca96b4f19d2a5296 Mon Sep 17 00:00:00 2001 From: Ekaterina Date: Tue, 24 Dec 2024 15:16:40 +0100 Subject: [PATCH] Release v0.6.0 (#1264) * Update release notes * Add a clarification to the release guide * Update the config versions * Clarify the release guidance * Restore minor changes --------- Co-authored-by: Davide Fioriti <67809479+davide-f@users.noreply.github.com> --- config.default.yaml | 2 +- config.tutorial.yaml | 2 +- doc/conf.py | 2 +- doc/release_notes.rst | 14 +++++++++++--- test/config.custom.yaml | 2 +- test/config.landlock.yaml | 2 +- test/config.monte_carlo.yaml | 2 +- test/config.sector.yaml | 2 +- test/config.test_myopic.yaml | 2 +- 9 files changed, 19 insertions(+), 11 deletions(-) diff --git a/config.default.yaml b/config.default.yaml index 715a8a4a9..ed8554002 100644 --- a/config.default.yaml +++ b/config.default.yaml @@ -2,7 +2,7 @@ # # SPDX-License-Identifier: CC0-1.0 -version: 0.5.0 +version: 0.6.0 tutorial: false logging: diff --git a/config.tutorial.yaml b/config.tutorial.yaml index 7ada63032..8f31af9bf 100644 --- a/config.tutorial.yaml +++ b/config.tutorial.yaml @@ -2,7 +2,7 @@ # # SPDX-License-Identifier: CC0-1.0 -version: 0.5.0 +version: 0.6.0 tutorial: true diff --git a/doc/conf.py b/doc/conf.py index cf4323277..b8ff6c30c 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -65,7 +65,7 @@ copyright = f"{datetime.datetime.today().year}, {author}" # The full version, including alpha/beta/rc tags -release = "0.5.0" +release = "0.6.0" # The name of the Pygments (syntax highlighting) style to use. pygments_style = "sphinx" diff --git a/doc/release_notes.rst b/doc/release_notes.rst index cf5b93895..280904488 100644 --- a/doc/release_notes.rst +++ b/doc/release_notes.rst @@ -13,13 +13,21 @@ This part of documentation collects descriptive release notes to capture the mai **New Features and Major Changes** + +**Minor Changes and bug-fixing** + + +PyPSA-Earth 0.6.0 +================= + +**New Features and Major Changes (24th December 2024)** + * Include option in the config to allow for custom airport data `PR #1241 `__ * Added Dev Containers and docker as an option to get started with pypsa-earth `PR #1228 `__ * Add a list of PyPSA-Earth applications in academic and industrial projects `PR #1255 `__ - * Computational improvements of build_osm_network `PR #845 `__ * Boost computational performances of set_lines_ids with cKDTree by scipy `PR #806 `__ @@ -537,13 +545,13 @@ Release Process * Make sure thah pinned versions of the environments ``*-pinned.yaml`` in ``envs`` folder are up-to-date. -* Update version number in ``doc/conf.py`` and ``*config.*.yaml``. +* Update version number in ``doc/conf.py``, ``default.config.yaml``, ``tutorial.config.yaml`` and ``test/config.*.yaml``. * Open, review and merge pull request for branch ``release-v0.x.x``. Make sure to close issues and PRs or the release milestone with it (e.g. closes #X). Run ``pre-commit run --all`` locally and fix any issues. -* Tag a release on Github via ``git tag v0.x.x``, ``git push``, ``git push --tags``. Include release notes in the tag message. +* Update and checkout your local `main` and tag a release with ``git tag v0.x.x``, ``git push``, ``git push --tags``. Include release notes in the tag message using Github UI. * Upload code to `zenodo code repository `_ with `GPLv3 license `_. diff --git a/test/config.custom.yaml b/test/config.custom.yaml index a596a932d..5cd36f44f 100644 --- a/test/config.custom.yaml +++ b/test/config.custom.yaml @@ -3,7 +3,7 @@ # SPDX-License-Identifier: CC0-1.0 ### CHANGES TO CONFIG.TUTORIAL.YAML ### -version: 0.5.0 +version: 0.6.0 run: name: "custom" diff --git a/test/config.landlock.yaml b/test/config.landlock.yaml index 913211f29..fc267e829 100644 --- a/test/config.landlock.yaml +++ b/test/config.landlock.yaml @@ -3,7 +3,7 @@ # SPDX-License-Identifier: CC0-1.0 ### CHANGES TO CONFIG.TUTORIAL.YAML ### -version: 0.5.0 +version: 0.6.0 countries: ["BW"] diff --git a/test/config.monte_carlo.yaml b/test/config.monte_carlo.yaml index 034dd51cd..c35dde51f 100644 --- a/test/config.monte_carlo.yaml +++ b/test/config.monte_carlo.yaml @@ -3,7 +3,7 @@ # SPDX-License-Identifier: CC0-1.0 ### CHANGES TO CONFIG.TUTORIAL.YAML ### -version: 0.5.0 +version: 0.6.0 monte_carlo: options: diff --git a/test/config.sector.yaml b/test/config.sector.yaml index abc250e0c..670344b0a 100644 --- a/test/config.sector.yaml +++ b/test/config.sector.yaml @@ -2,7 +2,7 @@ # # SPDX-License-Identifier: AGPL-3.0-or-later -version: 0.5.0 +version: 0.6.0 tutorial: true run: diff --git a/test/config.test_myopic.yaml b/test/config.test_myopic.yaml index 05f3c71a1..382def55f 100644 --- a/test/config.test_myopic.yaml +++ b/test/config.test_myopic.yaml @@ -2,7 +2,7 @@ # # SPDX-License-Identifier: AGPL-3.0-or-later -version: 0.5.0 +version: 0.6.0 logging_level: INFO tutorial: true