Plugin: updater-npm
Updates the version field in a package.json file. Use it to keep Node.js packages aligned with the version selected by SemRel.
Installation
Section titled “Installation”Binary
Section titled “Binary”semrel plugin install @semrel/updater-npmsemrel plugin install downloads the binary to .semrel/plugins/ and updates .semrel.lock. Commit .semrel.lock to pin the version for your team.
Docker
Section titled “Docker”Pre-built, signed multi-platform images (linux/amd64, linux/arm64) are published on every release:
docker pull ghcr.io/semrels/updater-npm:latestVerify the image signature with cosign:
cosign verify ghcr.io/semrels/updater-npm:latest \ --certificate-identity-regexp 'https://github.com/SemRels/updater-npm/.github/workflows/release.yml.*' \ --certificate-oidc-issuer https://token.actions.githubusercontent.comConfiguration
Section titled “Configuration”version: 1plugins: - uses: @semrel/updater-npm args: file: package.jsonEnvironment Variables
Section titled “Environment Variables”| Name | Required | Default | Description |
|---|---|---|---|
SEMREL_PLUGIN_FILE | no | package.json | Package manifest to update. |
Release Context Variables
Section titled “Release Context Variables”SEMREL_NEXT_VERSIONSEMREL_CURRENT_VERSIONSEMREL_TAG_NAMESEMREL_DRY_RUN
Behavior
Section titled “Behavior”For a 1.4.0 release, the updater can change "version": "1.3.2" to "version": "1.4.0" in package.json.