PKR-Lab

Releases

Quelle: pkr-lab/pkr-lab-docs/PowerShell/releases.md

Releases

Releases entstehen automatisch aus den Commit-Nachrichten. Der Prozess ist in allen Repos von pkr-lab gleich und läuft über die wiederverwendbaren Workflows im Repo pkr-lab/.github, beschrieben unter github-workflows.

Ablauf

  1. Änderungen kommen per Pull Request nach master. Der Check commitlint prüft, dass alle Commits des Pull Requests dem Format Conventional Commits folgen. Dazu laufen PSScriptAnalyzer und shellcheck (Qualitätsprüfung).
  2. Jeder Push auf master startet .github/workflows/release.yml. Der Workflow ruft den zentralen Release-Workflow auf (semantic-release).
  3. semantic-release bestimmt aus den Commits seit dem letzten Tag die nächste Version nach SemVer, schreibt CHANGELOG.md fort (Commit chore(release): X.Y.Z [skip ci]), setzt den Git-Tag vX.Y.Z und veröffentlicht ein GitHub-Release mit Release Notes.
Commit Wirkung
fix: Patch (1.2.3 → 1.2.4)
feat: Minor (1.2.3 → 1.3.0)
feat!: oder BREAKING CHANGE: im Footer Major (1.2.3 → 2.0.0)
docs:, chore:, refactor:, test:, ci:, build:, perf:, style: kein Release

Format: <typ>(<scope>): <beschreibung>, Der Typ und der Scope sind kleingeschrieben, die Beschreibung endet ohne Punkt, die Kopfzeile ist höchstens 120 Zeichen lang. Lokal prüft der Hook .githooks/commit-msg dasselbe; aktivieren mit git config core.hooksPath .githooks.

Versionen

Die Versionierung beginnt bei v1.0.0. Der Standardbranch heißt noch master; Release-Workflow und Commitlint laufen auf main und master, bis der Branch umbenannt ist.

Artefakte

Pro Release hängt ein ZIP (PowerShell-vX.Y.Z.zip) mit allen Skripten, Logging.psm1, Common.psm1 und Konfiguration.example.psd1 am GitHub-Release; es dient als Vorlage für die Sync-Quelle. Konfiguration.psd1 ist nie enthalten. Das ZIP baut .github/release/build.sh mit git archive, ohne .github und .githooks.

Änderungsprotokoll

CHANGELOG.md im Repo und die GitHub Releases.