Skip to content

GITHUB_RELEASES.md

Latest commit

 

History

History
274 lines (201 loc) · 6.4 KB

GITHUB_RELEASES.md

File metadata and controls

274 lines (201 loc) · 6.4 KB

GitHub Releases & Versioning Guide

Semantische Versionierung (SemVer)

Diese Integration folgt Semantic Versioning 2.0.0:

MAJOR.MINOR.PATCH
  • MAJOR: Breaking Changes (z.B. API-Änderungen, HA-Anforderungen erhöht)
  • MINOR: Neue Features (abwärtskompatibel)
  • PATCH: Bugfixes (keine neuen Features)

Aktuelle Version

0.1.4
└─ Validation improvements & precondition enum

Version Roadmap

Version Status Merkmale
0.0.1 ✅ Veröffentlicht Initial Release, Basis-Features
0.0.2 ✅ Veröffentlicht WebSocket-Unterstützung, Entity Manager
0.0.3 ✅ Veröffentlicht Services (set/del), Fehlerbehandlung
0.0.4 ✅ Veröffentlicht Entity-ID Vereinfachung, Optimierungen
0.0.5 ✅ Veröffentlicht HACS Default Store, Home Assistant Brands
0.1.0 ✅ Veröffentlicht Stable Release, WS/Polling Konfiguration, WS API
0.1.1 ✅ Veröffentlicht Patch: Repo-Links/Codeowner auf diestrohs, Dokumentation aktualisiert
0.1.2 ✅ Veröffentlicht Patch: BaseEvccPlanEntity, Service-Optimierung, Icons, Dokumentation
0.1.3 ✅ Veröffentlicht Strikte Service-Validierung, robustere Fehlerbehandlung, Docs aktualisiert
0.1.4 ✅ Veröffentlicht Fix: precondition als Enum 0/1/2, Doku/Services angepasst

Release-Prozess

1. Vorbereitung

Vor jedem Release:

# 1. Changelog/Notizen sammeln
# 2. Tests durchführen:
#    - Integration in HA 2025.12 installieren
#    - Alle Services testen
#    - Fahrzeugwechsel testen
#    - WebSocket & Polling testen
# 3. Versionen synchronisieren:

# manifest.json updaten
{
  "version": "0.1.2"
}

# hacs.json hat keine Version (kommt aus manifest.json)

2. GitHub Release erstellen

Via GitHub Web UI:

  1. Repository → Releases → Draft a new release
  2. Tag: 0.1.2 (exakt mit manifest.json)
  3. Target: master (default branch)
  4. Title: Release 0.1.2
  5. Description: (s. Beispiel unten)
  6. Options:
    • This is a pre-release (nur für Beta-Versionen)
    • Create a discussion (optional)
  7. Publish

Via Git CLI:

git tag 0.1.4
git push origin 0.1.4
# Dann Release auf GitHub UI erstellen mit Notes (siehe RELEASE_NOTES_v0.1.4.md)

3. Release-Notes Vorlage

## 🎉 Release 0.1.2

**Highlights**: BaseEvccPlanEntity, vereinheitlichtes Plattform-Setup, Service-Optimierung (weniger API-Calls), Icons (Time/Number), SOC-Slider Schrittweite 10

### What's new?

#### ✨ Features
- Feature 1
- Feature 2

#### 🐛 Fixes
- Bug fix 1
- Bug fix 2

#### 📚 Documentation
- Documentation updates
- New guides

#### ⚡ Performance
- Performance improvement 1
- Optimization 2

### 🔄 Dependencies

- Home Assistant: 2025.12.0+
- EVCC: 0.210.2+
- Python: 3.11+
- aiohttp: 3.8.0+

### 📝 Installation

HACS → Integrationen → EVCC Scheduler → Aktualisieren


### 🙏 Credits

Thanks to:
- Contributors
- Testers
- EVCC team

### 📦 Files Changed

- `manifest.json`: Version bumped
- `entity_manager.py`: Performance improvements
- `DOCUMENTATION.md`: Updated examples
- Plus weitere...

Release-Notes für aktuelle Version (0.1.4)

## 🎉 Release 0.1.4

**Highlights**: `precondition` als Enum (0/1/2), klarere Service-Validierung

### What's new?

#### 🛠️ Fixes
- `precondition` akzeptiert ausschließlich 0, 1 oder 2 (statt bool)
- Services-Validierung präzisiert, `services.yaml` Selector auf Zahlen 0–2
- README & Dokumentation (DE/EN) angepasst

### 🔄 Dependencies

- Home Assistant: 2025.12.0+
- EVCC: 0.210.2+
- Python: 3.11+
- aiohttp: 3.8.0+

### 🔄 Breaking Changes

- Keine. Entity-IDs bleiben stabil (`evcc_{fahrzeug}_repeating_plan_{index}_*`).

### 📝 Installation

HACS → Integrationen → EVCC Scheduler → Aktualisieren


### 📋 Checkliste nach Update

- [ ] Home Assistant neu gestartet
- [ ] WebSocket-Updates werden empfangen (oder Polling-Fallback getestet)
- [ ] Fahrzeugwechsel getestet (Entities bleiben stabil)
- [ ] Services `set_repeating_plan` / `del_repeating_plan` funktionieren

### 🙏 Credits

Vielen Dank an:
- Home Assistant Community
- EVCC Team & Community
- Beta-Tester

### 📝 Bekannte Probleme

Keine bekannten Probleme in dieser Version.

### 🔮 Next Steps

- Version 0.1.2: Bugfixes & HACS Review Tasks
- Version 0.2.0: Erweiterte Scheduling-Features / Templates

Automatisierte Release-Prozesse (Optional)

GitHub Actions für automatische Releases

# .github/workflows/release.yml
name: Create Release

on:
  push:
    tags:
      - "*"

jobs:
  release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Create Release
        uses: softprops/action-gh-release@v1
        with:
          body: |
            Release notes here
          draft: false
          prerelease: false

Version-Synchronisierung checken

Skript zum Prüfen, ob alle Versionen synchron sind:

#!/bin/bash
# check_versions.sh

MANIFEST_VERSION=$(grep '"version"' manifest.json | sed 's/.*"\([^"]*\)".*/\1/')
LATEST_TAG=$(git describe --tags --abbrev=0 2>/dev/null || echo "none")

echo "manifest.json version: $MANIFEST_VERSION"
echo "Latest git tag: $LATEST_TAG"

if [ "$MANIFEST_VERSION" = "$LATEST_TAG" ]; then
    echo "✅ Versionen synchron"
else
    echo "❌ Versionen unterschiedlich!"
    echo "   → manifest.json aktualisieren: $MANIFEST_VERSION"
    echo "   → Git tag erstellen: git tag $MANIFEST_VERSION"
fi

Langfristige Versionsplanung

0.0.x Phase (Pre-Release)
  ├─ 0.0.1-0.0.4: Feature-Development
  ├─ Focus: API-Stabilität, Core-Features
  └─ Breaking Changes möglich (kommuniziert)

0.1.0 Phase (First Stable)
  ├─ Stable API versprochen
  ├─ HACS Default Store ready
  └─ Semver eingehalten (keine Breaking Changes ohne Major)

0.2.0+ Phase (Maintenance)
  ├─ Bug Fixes (PATCH)
  ├─ Neue Features (MINOR)
  └─ Großere Refactorings (MAJOR)

Checkliste für neues Release

  • Changelog aktualisiert (CHANGELOG.md oder Release Notes)
  • manifest.json version aktualisiert
  • Alle Code-Changes committed
  • Git Tag erstellt: git tag X.X.X
  • Git Push mit Tags: git push origin master --tags
  • GitHub Release Draft erstellt
  • Release Notes aktualisiert
  • Veröffentlicht
  • HACS-Store automatisch aktualisiert wird (mit Verzögerung)

Letzte Aktualisierung: 25. Januar 2026
Aktuelle Version: 0.1.4