From c806b9ac1ab5f13c6ae61294e60ae93ec34d55a8 Mon Sep 17 00:00:00 2001 From: chrwm Date: Thu, 4 Apr 2024 08:28:28 +0200 Subject: [PATCH 1/6] Bump to version & update release date --- .bumpversion.cfg | 2 +- .github/workflows/ci-production.yml | 2 +- CITATION.cff | 4 ++-- setup.py | 4 ++-- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.bumpversion.cfg b/.bumpversion.cfg index 53daeb46..bba3789d 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 0.14.1 +current_version = 0.14.2 parse = (?P\d+)\.(?P\d+)\.(?P\d+)((?P(a|na))+(?P\d+))? serialize = {major}.{minor}.{patch}{release}{build} diff --git a/.github/workflows/ci-production.yml b/.github/workflows/ci-production.yml index d73609ea..87457cf0 100644 --- a/.github/workflows/ci-production.yml +++ b/.github/workflows/ci-production.yml @@ -31,7 +31,7 @@ jobs: - name: create package run: python setup.py sdist - name: import open-mastr - run: python -m pip install ./dist/open_mastr-0.14.1.tar.gz + run: python -m pip install ./dist/open_mastr-0.14.2.tar.gz - name: Create credentials file env: MASTR_TOKEN: ${{ secrets.MASTR_TOKEN }} diff --git a/CITATION.cff b/CITATION.cff index 90399709..d38cbfb5 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -28,7 +28,7 @@ authors: title: "open-MaStR" type: software license: AGPL-3.0 -version: 0.14.1 +version: 0.14.2 doi: -date-released: 2024-01-17 +date-released: 2024-04-04 url: "https://github.com/OpenEnergyPlatform/open-MaStR/" diff --git a/setup.py b/setup.py index 32649986..870cd9a6 100644 --- a/setup.py +++ b/setup.py @@ -19,14 +19,14 @@ "open_mastr.utils.config", "open_mastr.xml_download", ], - version="0.14.1", + version="0.14.2", description="A package that provides an interface for downloading and" " processing the data of the Marktstammdatenregister (MaStR)", long_description=long_description, long_description_content_type="text/x-rst", url="https://github.com/OpenEnergyPlatform/open-MaStR", download_url="https://github.com/OpenEnergyPlatform/open-MaStR/archive" - "/refs/tags/v0.14.1.tar.gz", + "/refs/tags/v0.14.2.tar.gz", author="Open Energy Family", author_email="datenzentrum@rl-institut.de", maintainer="Ludwig Hülk", From 935350a1ea77a5dd71e08e8f2eb506001d4aeb38 Mon Sep 17 00:00:00 2001 From: chrwm <54852694+chrwm@users.noreply.github.com> Date: Thu, 4 Apr 2024 08:33:45 +0200 Subject: [PATCH 2/6] Update CHANGELOG.md --- CHANGELOG.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 04115f7d..d287fa0b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,8 +6,7 @@ For each version important additions, changes and removals are listed here. The format is inspired from [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and the versioning aims to respect [Semantic Versioning](http://semver.org/spec/v2.0.0.html). -## [v0.XX.X] unreleased - 2024-XX-XX -### Added +## [v0.14.2] Maintenance - 2024-04-04 ### Changed - Fix and add URLs of example projects in readme [#481](https://github.com/OpenEnergyPlatform/open-MaStR/pull/481) - No longer require web scraping for bulk download [#488](https://github.com/OpenEnergyPlatform/open-MaStR/pull/488) From 0dc9913171047adb80c3cab48c120f78ffdaede0 Mon Sep 17 00:00:00 2001 From: chrwm <54852694+chrwm@users.noreply.github.com> Date: Thu, 4 Apr 2024 08:37:56 +0200 Subject: [PATCH 3/6] Update CHANGELOG.md --- CHANGELOG.md | 1 - 1 file changed, 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d287fa0b..0bb30aac 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,7 +20,6 @@ and the versioning aims to respect [Semantic Versioning](http://semver.org/spec/ ### Changed - Change data type of NetzbetreiberpruefungStatus to string [#483](https://github.com/OpenEnergyPlatform/open-MaStR/pull/483) - ## [v0.14.0] Shiny New Documentation Page - 2023-11-22 ### Added - User-defined output path for csv, xml, database [#402](https://github.com/OpenEnergyPlatform/open-MaStR/pull/402) From ef5dc7ead2bea75c76520f7e87d75ac66b048a1f Mon Sep 17 00:00:00 2001 From: Florian Kotthoff <74312290+FlorianK13@users.noreply.github.com> Date: Wed, 10 Apr 2024 09:14:03 +0200 Subject: [PATCH 4/6] Update release date #504 --- CHANGELOG.md | 2 +- CITATION.cff | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0bb30aac..2982a01c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,7 +6,7 @@ For each version important additions, changes and removals are listed here. The format is inspired from [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and the versioning aims to respect [Semantic Versioning](http://semver.org/spec/v2.0.0.html). -## [v0.14.2] Maintenance - 2024-04-04 +## [v0.14.2] Maintenance - 2024-04-10 ### Changed - Fix and add URLs of example projects in readme [#481](https://github.com/OpenEnergyPlatform/open-MaStR/pull/481) - No longer require web scraping for bulk download [#488](https://github.com/OpenEnergyPlatform/open-MaStR/pull/488) diff --git a/CITATION.cff b/CITATION.cff index d38cbfb5..69b1ae0a 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -30,5 +30,5 @@ type: software license: AGPL-3.0 version: 0.14.2 doi: -date-released: 2024-04-04 +date-released: 2024-04-10 url: "https://github.com/OpenEnergyPlatform/open-MaStR/" From 66a3bd4d8f3f959ef541daaec10d2def0d21655c Mon Sep 17 00:00:00 2001 From: Florian Kotthoff <74312290+FlorianK13@users.noreply.github.com> Date: Wed, 10 Apr 2024 09:45:37 +0200 Subject: [PATCH 5/6] Update Changelog for new development --- CHANGELOG.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2982a01c..fd429948 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,12 @@ For each version important additions, changes and removals are listed here. The format is inspired from [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and the versioning aims to respect [Semantic Versioning](http://semver.org/spec/v2.0.0.html). + +## [v0.XX.X] - 202X-XX-XX +### Added +### Changed +### Removed + ## [v0.14.2] Maintenance - 2024-04-10 ### Changed - Fix and add URLs of example projects in readme [#481](https://github.com/OpenEnergyPlatform/open-MaStR/pull/481) From 264135a0bf51b3dfce9afb29ff6de782956a8fbd Mon Sep 17 00:00:00 2001 From: Florian Kotthoff <74312290+FlorianK13@users.noreply.github.com> Date: Wed, 10 Apr 2024 09:54:21 +0200 Subject: [PATCH 6/6] Update release procedure --- RELEASE_PROCEDURE.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/RELEASE_PROCEDURE.md b/RELEASE_PROCEDURE.md index 6b817b0d..86c7189e 100644 --- a/RELEASE_PROCEDURE.md +++ b/RELEASE_PROCEDURE.md @@ -40,8 +40,6 @@ It always has the format `YYYY-MM-DD`, e.g. `2022-05-16`. ### 3. 🐙 Create a `Draft GitHub Release` * [Draft a new release](https://github.com/OpenEnergyPlatform/open-MaStR/releases/new) * Enter the release version number `v0.12.1` as title -* Summarize key changes in the description - * Use the `generate release notes` button provided by github (This might only work after the release branch is merged on production) * Save draft ### 4. 🐙 Finish all planned Developments @@ -52,7 +50,7 @@ It always has the format `YYYY-MM-DD`, e.g. `2022-05-16`. ### 5. 💠 Create a `release` branch * Checkout `develop` and branch with `git checkout -b release-v0.12.1` -* Update version for test release with e.g. `bump2version patch`. To specify version numbers manually use `bump2version --current-version --new-version patch` +* Update version for test release with `bump2version --current-version --new-version patch` * Commit version update with `git commit -am "version update v0.12.1a1"` * Push branch with `git push --set-upstream origin release-v0.12.1` @@ -77,11 +75,11 @@ It always has the format `YYYY-MM-DD`, e.g. `2022-05-16`. ### 8. 🐙 Create a `Release Pull Request` * Use `📝PR_TEMPLATE_RELEASE` (❗ToDo❗) * Merge `release` into `production` branch -* Assign two reviewers to check the release +* Assign reviewers to check the release * Run all test * Execute the software locally * Wait for reviews and tests -* Merge PR and delete `release` branch +* Merge PR ### 9. 💠 Set the `Git Tag` * Checkout `production` branch and pull @@ -96,6 +94,7 @@ It always has the format `YYYY-MM-DD`, e.g. `2022-05-16`. ### 10. 🐙 Publish `Release` on GitHub and PyPI * Navigate to your [releases](https://github.com/OpenEnergyPlatform/open-MaStR/releases/) on GitHub and open your draft release. * Summarize key changes in the description + * Use the `generate release notes` button provided by github (This only works after the release branch is merged on production) * Choose the correct git `tag` * Choose the `production` branch * Publish release @@ -105,7 +104,7 @@ It always has the format `YYYY-MM-DD`, e.g. `2022-05-16`. ▶️ In the background the GitHub workflow (pypi-publish.yml) will publish the package 📦 on PyPI! ### 11. 🐙 Set up new development -* Create a Pull request from `production` to `develop` +* Create a Pull request from `release-*` to `develop` * Create a new **unreleased section** in the `📝CHANGELOG.md` ``` ## [v0.XX.X] unreleased @@ -113,11 +112,13 @@ It always has the format `YYYY-MM-DD`, e.g. `2022-05-16`. ### Changed ### Removed ``` +* Merge `release-*` to `develop` and delete `release-*` branch ▶️ Continue the developments 🛠 ## Documentation on Read the Docs (RTD) -ToDo +* ReadTheDocs triggers a new built automatically after the release on github. To see + the build status, visit https://readthedocs.org/projects/open-mastr/builds/ ## Sources: