Plugin: updater-composer

Aktualisiert das Feld version in composer.json für PHP-Projekte, sofern dies explizit aktiviert ist. Da Composer 2.x Paketversionen standardmäßig aus Git-Tags ableitet, lässt dieses Plugin composer.json unverändert, solange nicht update_version_field: "true" gesetzt ist.

Installation

Binärdatei

semrel plugin install @semrel/updater-composer

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.

Docker

Vorgefertigte, signierte Multi-Plattform-Images (linux/amd64, linux/arm64) werden bei jedem Release veröffentlicht:

docker pull ghcr.io/semrels/updater-composer:latest

Überprüfe die Image-Signatur mit cosign:

cosign verify ghcr.io/semrels/updater-composer:latest \
  --certificate-identity-regexp 'https://github.com/SemRels/updater-composer/.github/workflows/release.yml.*' \
  --certificate-oidc-issuer https://token.actions.githubusercontent.com

Konfiguration

version: 1
plugins:
  - uses: @semrel/updater-composer
    phase: pre-tag
    args:
      file: composer.json
      update_version_field: "true"

Umgebungsvariablen

Name	Erforderlich	Standard	Beschreibung
`SEMREL_PLUGIN_FILE`	nein	`composer.json`	Pfad zur `composer.json`-Datei.
`SEMREL_PLUGIN_COMPOSER_FILE`	nein	`—`	Alias für `SEMREL_PLUGIN_FILE`.
`SEMREL_PLUGIN_UPDATE_VERSION_FIELD`	nein	`false`	Wenn `true`, wird das Feld `version` in `composer.json` aktualisiert oder ergänzt.

Release-Kontextvariablen

SEMREL_VERSION
SEMREL_NEXT_VERSION
SEMREL_DRY_RUN

Verhalten

Standardmäßig führt das Plugin keine Dateiänderung durch und protokolliert den Hinweis auf den Opt-in-Modus. Bei SEMREL_PLUGIN_UPDATE_VERSION_FIELD=true entfernt es ein führendes v von der Release-Version und schreibt die SemVer-Version unter Beibehaltung der Schlüsselreihenfolge und Formatierung in composer.json.

Quelle

SemRels/updater-composer