PKR-Lab

Installation

Quelle: pkr-lab/pkr-lab-docs/github-workflows/installation.md

Installation

Ein Repo bekommt Releases und Commit-Prüfung mit zwei Aufruferdateien und einem optionalen Hook.

Voraussetzungen

Setup

.github/workflows/release.yml:

name: Release

on:
  push:
    branches: [main]
  workflow_dispatch: {}

permissions:
  contents: write
  issues: write
  pull-requests: write
  packages: write

concurrency:
  group: release-${{ github.ref }}
  cancel-in-progress: false

jobs:
  release:
    uses: pkr-lab/.github/.github/workflows/release.yml@<commit-sha> # vX.Y.Z

.github/workflows/commitlint.yml:

name: Commitlint

on:
  pull_request:
    branches: [main]

permissions:
  contents: read

jobs:
  commitlint:
    uses: pkr-lab/.github/.github/workflows/commitlint.yml@<commit-sha> # vX.Y.Z

Den SHA liefert git rev-parse vX.Y.Z^{commit} im Repo .github. Ein vorhandenes .releaserc.json im Code-Repo löschen, der Workflow erzeugt die Konfiguration selbst.

Lokaler Hook

mkdir -p .githooks
cp /pfad/zu/.github/hooks/commit-msg .githooks/commit-msg
chmod +x .githooks/commit-msg
git config core.hooksPath .githooks

Bei Repos mit Makefile (capulus-core, capulus-ansible) erledigt make hooks den letzten Schritt.

Fehlersuche

Symptom Ursache Lösung
Workflow-Aufruf meldet „workflow was not found“ SHA oder Pfad im uses: falsch Nutzung: Fehlersuche
Kein Release nach dem Merge Commit-Format, nach dem letzten Tag keine Commits mit feat/fix Nutzung: Fehlersuche
commit-msg-Hook lehnt ab Kopfzeile verletzt das Format, endet mit Punkt oder ist länger als 120 Zeichen <typ>(<scope>): <beschreibung> (Lokaler Hook)
Hook wird nicht ausgeführt Datei nach dem Kopieren nicht ausführbar chmod +x .githooks/commit-msg
Push auf main abgelehnt Branch-Schutz PR verwenden, Branch-Schutz (capulus-core)