Plugin: provider-github

Veröffentlicht Releases in GitHub mit dem erzeugten semrel-Tag, der Version und dem Changelog. Es unterstützt Flags für Draft und Prerelease und kann passende Assets aus dem lokalen Workspace hochladen.

Installation

semrel plugin install @semrel/provider-github

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/provider-github
    args:
      # Token wird aus SEMREL_PLUGIN_TOKEN oder GITHUB_TOKEN gelesen
      owner: SemRels
      repo: semrel
      draft: false
      prerelease: false
      assets: 'dist/*.tar.gz,dist/*.zip'
      comment_on_prs: "true"

Umgebungsvariablen

Name	Erforderlich	Standard	Beschreibung
`SEMREL_PLUGIN_TOKEN`	ja	`GITHUB_TOKEN`	GitHub-Token zum Erstellen des Releases (Fallback auf `GITHUB_TOKEN`).
`SEMREL_PLUGIN_OWNER`	nein	`aktueller Repository-Eigentümer`	Repository-Eigentümer oder Organisation.
`SEMREL_PLUGIN_REPO`	nein	`aktueller Repository-Name`	Repository-Name, in dem veröffentlicht wird.
`SEMREL_PLUGIN_BASE_URL`	nein	`https://api.github.com`	GitHub-API-Basis-URL (unterstützt GHES `/api/v3` und `*.ghe.com`; Fallback auf `SEMREL_PLUGIN_API_URL` und `GITHUB_API_URL`).
`SEMREL_PLUGIN_API_URL`	nein	`https://api.github.com`	Alias für `SEMREL_PLUGIN_BASE_URL`.
`SEMREL_PLUGIN_CA_CERT`	nein	`—`	Pfad zu einem PEM-kodierten CA-Zertifikatsbundle für selbstsignierte/interne GHES-Instanzen.
`SEMREL_PLUGIN_INSECURE_SKIP_VERIFY`	nein	`false`	TLS-Zertifikatsprüfung überspringen (`true`/`1`). Nur als letzter Ausweg.
`SEMREL_PLUGIN_DRAFT`	nein	`false`	Das Release als Draft erstellen.
`SEMREL_PLUGIN_PRERELEASE`	nein	`false`	Das Release als Prerelease markieren.
`SEMREL_PLUGIN_ASSETS`	nein	`—`	Kommagetrennte Dateipfade oder Glob-Muster für hochzuladende Release-Assets.
`SEMREL_PLUGIN_COMMENT_ON_PRS`	nein	`true`	Kommentiert automatisch (idempotent) alle im Release enthaltenen Pull Requests (`SEMREL_COMMIT_HASHES`).

Release-Kontextvariablen

SEMREL_VERSION
SEMREL_TAG_NAME
SEMREL_NEXT_VERSION
SEMREL_CURRENT_VERSION
SEMREL_CHANGELOG
SEMREL_COMMIT_HASHES
SEMREL_DRY_RUN

Verhalten

Für v1.4.0 erstellt der Provider ein GitHub-Release, hängt Dateien passend zu SEMREL_PLUGIN_ASSETS an, veröffentlicht den semrel-Changelog als Release Notes und hinterlässt automatisch einen Release-Kommentar in allen zugehörigen Pull Requests. Unterstützt GitHub Enterprise Server (GHES) und Data Residency (*.ghe.com) ohne Zusatzaufwand.

Quelle

SemRels/provider-github