Plugin: condition-github-actions

Bestätigt, dass das aktuelle Release innerhalb von GitHub Actions läuft. Funktioniert out-of-the-box auf github.com, GitHub Enterprise Server (GHES) sowie GitHub Enterprise Cloud mit Data Residency (*.ghe.com).

Installation

semrel plugin install @semrel/condition-github-actions

semrel plugin install lädt die Binärdatei nach .semrel/plugins/ herunter und aktualisiert .semrel.lock. Committe .semrel.lock, um die Version für dein Team festzuschreiben.

Konfiguration

version: 1
plugins:
  - uses: @semrel/condition-github-actions
    phase: condition
    args:
      branch: main

Umgebungsvariablen

Name	Erforderlich	Standard	Beschreibung
`SEMREL_PLUGIN_BRANCH`	nein	`—`	Optionale Branch-Vorgabe. Wenn gesetzt, muss `GITHUB_REF_NAME` (bzw. `GITHUB_REF` ohne `refs/heads/`) diesem Wert entsprechen.

GitHub Actions & Enterprise-Umgebung

Variable	Erforderlich	Beschreibung
`GITHUB_ACTIONS`	ja	Muss `"true"` sein.
`GITHUB_TOKEN` / `GH_TOKEN`	ja	Mindestens eine Token-Variable muss gesetzt sein.
`GITHUB_REF_NAME` / `GITHUB_REF`	nein	Wird bei gesetztem `SEMREL_PLUGIN_BRANCH` geprüft (inkl. Fallback auf `GITHUB_REF` für ältere GHES-Runner).
`GITHUB_SERVER_URL`	nein	Optionale GitHub-Server-URL (z. B. `https://github.com`, `https://ghe.example.com` oder `https://octocorp.ghe.com`). Wird als `http`/`https`-URL validiert.
`GITHUB_API_URL`	nein	Optionale GitHub-API-URL (z. B. `https://api.github.com`, `https://ghe.example.com/api/v3` oder `https://api.octocorp.ghe.com`). Wird als `http`/`https`-URL validiert.

Release-Kontextvariablen

Dieses Plugin benötigt keine der gemeinsamen SEMREL_*-Release-Kontextvariablen, um seine Aufgabe zu erledigen.

Verhalten

Wenn GITHUB_ACTIONS=true sowie ein gültiges Token und gültige Server-/API-URLs vorliegen, ist das Plugin sofort erfolgreich. Andernfalls schlägt die Bedingung fehl und semrel stoppt die Pipeline.

Quelle

SemRels/condition-github-actions