Skip to content
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.

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

Release v0.14.2 back to develop #508

Merged
merged 6 commits into from
Apr 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .bumpversion.cfg
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[bumpversion]
current_version = 0.14.1
current_version = 0.14.2
parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)((?P<release>(a|na))+(?P<build>\d+))?
serialize =
{major}.{minor}.{patch}{release}{build}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci-production.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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 }}
Expand Down
8 changes: 6 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,14 @@ 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

## [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)
- No longer require web scraping for bulk download [#488](https://github.com/OpenEnergyPlatform/open-MaStR/pull/488)
- Replace deprecated pandas map function [#491](https://github.com/OpenEnergyPlatform/open-MaStR/pull/491)
Expand All @@ -21,7 +26,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)
Expand Down
4 changes: 2 additions & 2 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -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-10
url: "https://github.com/OpenEnergyPlatform/open-MaStR/"
15 changes: 8 additions & 7 deletions RELEASE_PROCEDURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 <current_version> --new-version <new_version> patch`
* Update version for test release with `bump2version --current-version <current_version> --new-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`

Expand All @@ -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
Expand All @@ -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
Expand All @@ -105,19 +104,21 @@ 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
### Added
### 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:
Expand Down
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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="[email protected]",
maintainer="Ludwig Hülk",
Expand Down
Loading