chore(release): Release v0.2.0

Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
2025-11-21 04:46:31 +00:00 · 2025-11-09 09:07:04 +01:00
parent 3599088dce
commit 2e9902c459
12 changed files with 389 additions and 123 deletions
--- a/docs/_generated/config.md
+++ b/docs/_generated/config.md
@@ -21,7 +21,7 @@ Properties:

 | Name | Environment Variable | Type | Read-Only | Default | Description |
 | ---- | -------------------- | ---- | --------- | ------- | ----------- |
-| version | `EOS_GENERAL__VERSION` | `str` | `rw` | `0.1.0+dev` | Configuration file version. Used to check compatibility. |
+| version | `EOS_GENERAL__VERSION` | `str` | `rw` | `0.2.0` | Configuration file version. Used to check compatibility. |
 | data_folder_path | `EOS_GENERAL__DATA_FOLDER_PATH` | `Optional[pathlib.Path]` | `rw` | `None` | Path to EOS data directory. |
 | data_output_subpath | `EOS_GENERAL__DATA_OUTPUT_SUBPATH` | `Optional[pathlib.Path]` | `rw` | `output` | Sub-path for the EOS output data directory. |
 | latitude | `EOS_GENERAL__LATITUDE` | `Optional[float]` | `rw` | `52.52` | Latitude in decimal degrees, between -90 and 90, north is positive (ISO 19115) (°) |
@@ -39,7 +39,7 @@ Properties:

   {
       "general": {
-           "version": "0.1.0+dev",
+           "version": "0.2.0",
           "data_folder_path": null,
           "data_output_subpath": "output",
           "latitude": 52.52,
@@ -55,7 +55,7 @@ Properties:

   {
       "general": {
-           "version": "0.1.0+dev",
+           "version": "0.2.0",
           "data_folder_path": null,
           "data_output_subpath": "output",
           "latitude": 52.52,
@@ -1780,7 +1780,7 @@ Validators:

   {
       "general": {
-           "version": "0.1.0+dev",
+           "version": "0.2.0",
           "data_folder_path": null,
           "data_output_subpath": "output",
           "latitude": 52.52,
--- a/docs/_generated/openapi.md
+++ b/docs/_generated/openapi.md
@@ -1,6 +1,6 @@
 # Akkudoktor-EOS

-**Version**: `v0.1.0+dev`
+**Version**: `v0.2.0`

 **Description**: This project provides a comprehensive solution for simulating and optimizing an energy system based on renewable energy sources. With a focus on photovoltaic (PV) systems, battery storage (batteries), load management (consumer requirements), heat pumps, electric vehicles, and consideration of electricity price data, this system enables forecasting and optimization of energy flow and costs over a specified period.

--- a/docs/develop/install.md
+++ b/docs/develop/install.md
@@ -138,16 +138,16 @@ This method is recommended for users who want a stable, tested version.
 ### 1) Download the Latest Release (M2)

 Visit the [Releases page](https://github.com/Akkudoktor-EOS/EOS/tags) and download the latest
-release package (e.g., `akkudoktoreos-v0.1.0.tar.gz` or `akkudoktoreos-v0.1.0.zip`).
+release package (e.g., `akkudoktoreos-v0.2.0.tar.gz` or `akkudoktoreos-v0.2.0.zip`).

 ### 2) Extract the Package (M2)

 ```bash
-tar -xzf akkudoktoreos-v0.1.0.tar.gz  # For .tar.gz
+tar -xzf akkudoktoreos-v0.2.0.tar.gz  # For .tar.gz
 # or
-unzip akkudoktoreos-v0.1.0.zip  # For .zip
+unzip akkudoktoreos-v0.2.0.zip  # For .zip

-cd akkudoktoreos-v0.1.0
+cd akkudoktoreos-v0.2.0
 ```

 ### 3) Create a virtual environment and run and configure EOS (M2)
--- a/docs/develop/release.md
+++ b/docs/develop/release.md
@@ -4,7 +4,7 @@
 # Release Process

 This document describes how to prepare and publish a new release **via a Pull Request from a fork**,
-using **Commitizen** to manage versioning and changelogs — and how to set a **development version** after the release.
+and how to set a **development version** after the release.

 ## ✅ Overview of the Process

@@ -20,7 +20,7 @@ using **Commitizen** to manage versioning and changelogs — and how to set a **

 ### 1️⃣ Contributor: Prepare the Release in Your Fork

-**Clone and sync your fork:**
+#### Clone and sync your fork

 ```bash
 git clone https://github.com/<your-username>/EOS
@@ -32,25 +32,50 @@ git checkout main
 git pull eos main
 ````

-**Create the release branch:**
+#### Create the release branch

 ```bash
 git checkout -b release/vX.Y.Z
 ```

-**Run Commitizen to bump version and update changelog:**
+#### Bump the version information
+
+At least update
+
+- pyproject.toml
+- src/akkudoktoreos/core/version.py
+- src/akkudoktoreos/data/default.config.json
+- Makefile
+
+and the generated documentation:

 ```bash
-make bump
+make bump VERSION=0.1.0+dev NEW_VERSION=X.Y.Z
+make gen-docs
 ```

-> ✅ This updates version files and `CHANGELOG.md` in a single commit.
-> 🚫 **Do not push tags** — tags are created by the maintainer via GitHub Releases.
-
-**Push the branch to your fork:**
+You may check the changes by:

 ```bash
-git push origin release/vX.Y.Z
+git diff
+```
+
+#### Create a new CHANGELOG.md entry
+
+Edit CHANGELOG.md
+
+#### Create the new release commit
+
+```bash
+git add pyproject.toml src/akkudoktoreos/core/version.py \
+    src/akkudoktoreos/data/default.config.json Makefile CHANGELOG.md
+git commit -s -m "chore(release): Release vX.Y.Z"
+```
+
+#### Push the branch to your fork
+
+```bash
+git push --set-upstream origin release/vX.Y.Z
 ```

 ### 2️⃣ Contributor: Open the Release Pull Request
@@ -62,7 +87,7 @@ git push origin release/vX.Y.Z
 **PR Title:**

 ```text
-Release vX.Y.Z
+chore(release): release vX.Y.Z
 ```

 **PR Description Template:**
@@ -73,7 +98,7 @@ Release vX.Y.Z
 This pull request prepares release **vX.Y.Z**.

 ### Changes
- Version bump via Commitizen
+- Version bump
 - Changelog update

 ### Changelog Summary
@@ -86,15 +111,15 @@ See `CHANGELOG.md` for full details.

 **Review Checklist:**

-* ✅ Only version files and `CHANGELOG.md` are modified
-* ✅ Version numbers are consistent
-* ✅ Changelog is complete and properly formatted
-* ✅ No unrelated changes are included
+- ✅ Only version files and `CHANGELOG.md` are modified
+- ✅ Version numbers are consistent
+- ✅ Changelog is complete and properly formatted
+- ✅ No unrelated changes are included

 **Merge Strategy:**

-* Prefer **Merge Commit** (or **Squash Merge**, per project preference)
-* Use commit message: `Release vX.Y.Z`
+- Prefer **Merge Commit** (or **Squash Merge**, per project preference)
+- Use commit message: `chore(release): Release vX.Y.Z`

 ### 4️⃣ Maintainer: Publish the GitHub Release

@@ -121,21 +146,21 @@ git pull eos main
 git checkout -b release/vX.Y.Z_dev
 ```

-**Set development marker manually:**
-
-The following files have to be updated:
-
-* pyproject.toml
-* src/akkudoktoreos/core/version.py
-* src/data/default.config.json
-
-Example for pyproject.toml
+**Set development version marker manually:**

 ```bash
-sed -i 's/version = "\(.*\)"/version = "\1+dev"/' pyproject.toml
-git add pyproject.toml
-git commit -m "chore: set development version marker"
-git push origin release/vX.Y.Z_dev
+make bump VERSION=X.Y.Z NEW_VERSION=X.Y.Z+dev
+make gen-docs
+```
+
+```bash
+git add pyproject.toml src/akkudoktoreos/core/version.py \
+    src/akkudoktoreos/data/default.config.json Makefile
+git commit -s -m "chore: set development version marker X.Y.Z+dev"
+```
+
+```bash
+git push --set-upstream origin release/vX.Y.Z_dev
 ```

 ### 6️⃣ Maintainer (or Contributor): Open the Development Version PR
@@ -147,13 +172,13 @@ git push origin release/vX.Y.Z_dev
 **PR Title:**

 ```text
-Release vX.Y.Z+dev
+chore: development version vX.Y.Z+dev
 ```

 **PR Description Template:**

 ```markdown
-## Release vX.Y.Z_dev
+## Development version vX.Y.Z+dev

 This pull request marks the repository as back in active development.

@@ -167,12 +192,12 @@ No changelog entry is needed.

 **Checklist:**

-* ✅ Only version files updated to `+dev`
-* ✅ No unintended changes
+- ✅ Only version files updated to `+dev`
+- ✅ No unintended changes

 **Merge Strategy:**

-* Merge with commit message: `Release vX.Y.Z_dev`
+- Merge with commit message: `chore: development version vX.Y.Z+dev`

 ## ✅ Quick Reference