Skip to main content

npm-post

Commits updated package.json version field

This plugin is not essential but recommended to keep version field in sync

Required: No​

Environment variables​

Git variables​

These variable names used for creating tag(s) and commit(s)

NameDescriptionType
GIT_USERNAMESpecify tag author nameVariables
GIT_EMAILSpecify tag author e-mailVariables

GPG (Git) variables​

These variable names used for signing tag(s) and commit(s)

NameDescriptionType
GPG_NO_SIGNSkips Git SigningVariables
GPG_KEY_IDPublic GPG key/ring IDVariables
GPG_KEYPrivate GPG keySecrets
GPG_PASSPHRASEPrivate GPG passphraseSecrets

SSH (Git) variables​

These variable names used for signing tag(s) and commit(s)

NameDescriptionType
SSH_NO_SIGNSkips Git SigningVariables
SSH_PUBLIC_KEYPublic SSH key contentSecrets
SSH_PRIVATE_KEYPrivate SSH key contentSecrets
SSH_KEY_PASSPHRASEPrivate SSH passphraseSecrets

npm variables​

These variable names used for publishing to npm registry via the npm plugin

NameDescriptionType
NPM_TOKENOptional. Used to publish to npm registrySecrets

When NPM_TOKEN is not set, publishing falls back to Trusted publishing (OIDC) — supported on GitHub Actions with id-token: write permission and npm >= 11.5.1, no token required. The npm-post plugin itself runs whenever it is listed in --plugins, with or without a token.

When the GitHub CLI (gh) is available, the version bump lands as a release/<tag> branch Pull Request against the base branch — an existing PR for the same tag is updated, and auto-merge is attempted (enable "Allow auto-merge" in the repository settings). Without gh, it pushes the base branch directly.

Usage​

Bash (Terminal)
git clone https://github.com/dalisoft/release-me.git --depth 1 .release-me
bash .release-me/release.sh --plugins=npm,npm-post,git