plugin-drone-npm/DOCS.md

Use the NPM plugin to publish a library to a NPM registry.

The following parameters are used to configuration the publishing:

• username - the username for the account to publish with.
• password - the password for the account to publish with.
• token - the deploy token to publish with.
• email - the email address associated with the account to publish with.
• registry - the registry URL to use (https://registry.npmjs.org by default)
• folder - the folder, relative to the workspace, containing the library (uses the workspace directory, by default)

The following secret values can be set to configure the plugin.

• NPM_USERNAME - corresponds to username.
• NPM_PASSWORD - corresponds to password.
• NPM_TOKEN - corresponds to token.
• NPM_EMAIL - corresponds to email.
• NPM_REGISTRY - corresponds to registry.

It is highly recommended to put the NPM_PASSWORD or NPM_TOKEN into secrets. The other values are there for convenience when configuring multiple repositories to use the same values. This can be done using the drone-cli.

drone secret add --image=npm \
    octocat/hello-world NPM_PASSWORD abc123

Then sign the YAML file after all secrets are added.

drone sign octocat/hello-world

See secrets for additional information on secrets

Authentication method

NPM registries typically authenticate based on a username password pair. However NPM Enterprise users can also authenticate through tokens.

If a token value is encountered the plugin will use that. If it is not present then the plugin will default to username/password.

Examples

Global NPM with NPM_PASSWORD as a secret.

npm:
  username: bob
  email: bob@bob.me

A private NPM registry, such as Sinopia with NPM_PASSWORD as a secret.

npm:
  username: drone
  email: drone@drone.io
  registry: "http://myregistry:4873"

NPM Enterprise registry with NPM_TOKEN as a secret.

npm:
  registry: "http://myregistry:8081"