auto-plugin-understood v2.0.9

NPM Plugin

Publish to NPM. Works in both a monorepo setting and for a single package. This plugin is loaded by default when auto is installed through npm. If you configure auto to use any other plugin this will be lost. So you must add the npm plugin to your plugins array if you still want NPM functionality.

Prerequisites

To publish to npm you will need an NPM_TOKEN set in your environment.

Installation

This plugin is included with the auto CLI so you do not have to install it. To install if you are using the auto API directly:

npm i --save-dev @auto-it/npm
# or
yarn add -D @auto-it/npm

Usage

{
  "plugins": [
    "npm",
    // or with options
    ["npm", { "forcePublish": false }]
    // other plugins
  ]
}

Monorepo Usage

The npm plugin works out of the box with lerna in both independent and fixed mode. auto works on a repo basis and should be run from the root of the repo, not on each sub-package. No additional setup is required.

Options

setRcToken

When running the shipit command auto will try to set your .npmrc token while publishing. To disable this feature you must set the setRcToken to false.

{
  "plugins": [
    [
      "npm",
      {
        "setRcToken": false
      }
    ]
  ]
}

forcePublish

By default auto will force publish all packages for monorepos. To disable this behavior you must set the setRcToken to false.

{
  "plugins": [
    [
      "npm",
      {
        "forcePublish": false
      }
    ]
  ]
}

exact

To force all packages publish with exact versions.

{
  "plugins": [
    [
      "npm",
      {
        "exact": true
      }
    ]
  ]
}

subPackageChangelogs

auto will create a changelog for each sub-package in a monorepo. You can disable this behavior by using the subPackageChangelogs option.

{
  "plugins": [
    [
      "npm",
      {
        "subPackageChangelogs": false
      }
    ]
  ]
}

canaryScope

Publishing canary versions comes with some security risks. If your project is private you have nothing to worry about and can skip these, but if your project is open source there are some security holes.

::: message is-warning This feature works pretty easily/well for single packages. In a monorepo we have to deal with a lot more, and this options should be treated as experimental. :::

Setup

1. Create a test scope that you publish canaries under (ex: @auto-canary or @auto-test)
2. Create a user that only has access to that scope
3. Set the default NPM_TOKEN to a token that can publish to that scope (this is used for any pull request)
4. Set up a secure token that is only accessible on the main fork (still named NPM_TOKEN)
5. Set up alias (only monorepos)

Step 3 might not be possible on your build platform.

The following are the ways the auto team knows how to do it. If you do not see the method for you build platform, please make a pull request!

Platform Solutions:

• CircleCI Context - Contexts provide a mechanism for securing and sharing environment variables across projects. The environment variables are defined as name/value pairs and are injected at runtime.

{
  "plugins": [
    [
      "npm",
      {
        "canaryScope": "@auto-canary"
      }
    ]
  ]
}

Set up alias

If you are managing a non-monorepo you do not have to do anything for this step! If you manage a monorepo we still have to do handle our packages importing each other. Since we just changed the name of the package all imports to our packages are now broken!

There are multiple ways to make this work and the solution might be different depending on your build target.

• module-alias - Modifiy node's require for your canary deploys (This is what auto uses). Useful for node packages
• Webpack Aliases Modify scoped requires for webpack based projects.
• babel-plugin-module-resolver - A Babel plugin to add a new resolver for your modules when compiling your code using Babel.