@semantic-release/npm
Set of semantic-release plugins for publishing to a npm registry.
verifyConditions
Verify the presence of the NPM_TOKEN
environment variable, create or update the .npmrc
file with the token and verify the token is valid.
getLastRelease
Determine the last release of the package on the npm
registry.
publish
Update the package.json
version, create the npm
package tarball and publish to the npm
registry.
Configuration
Npm registry authentication
The npm
authentication configuration is required and can be set via environment variables.
Both the token and the legacy (username
, password
and email
) authentication are supported. It is recommended to use the token authentication. The legacy authentication is supported as the alternative npm registries Artifactory and npm-registry-couchapp only supports that form of authentication at this point.
Environment variables
Variable | Description |
---|---|
NPM_TOKEN |
Npm token created via npm token create |
NPM_USERNAME |
Npm username created via npm adduser or on npmjs.com |
NPM_PASSWORD |
Password of the npm user. |
NPM_EMAIL |
Email address associated with the npm user |
Use either NPM_TOKEN
for token authentication or NPM_USERNAME
, NPM_PASSWORD
and NPM_EMAIL
for legacy authentication
Options
Options | Description | Default |
---|---|---|
npmPublish |
Whether to publish the npm package to the registry. If false the package.json version will still be updated. |
true |
tarballDir |
Directory path in which to generate the the package tarball. If false the tarball is not be kept on the file system. |
false |
Npm configuration
The plugins are based on npm
and will use the configuration from .npmrc
. See npm config for the option list.
The registry
and dist-tag
can be configured in the package.json
and will take precedence over the configuration in .npmrc
:
Usage
The plugins are used by default by semantic-release so no specific configuration is requiered to use them.
Each individual plugin can be disabled, replaced or used with other plugins in the package.json
:
The npmPublish
and tarballDir
option can be used to skip the publishing to the npm
registry and instead, release the package tarball with another plugin. For example with the github: