Skip to content

Commit

Permalink
chore(docs): update publish readme to describe new behavior
Browse files Browse the repository at this point in the history
  • Loading branch information
fahslaj committed Jul 18, 2022
1 parent a0e5dbd commit 512536f
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions commands/publish/README.md
Expand Up @@ -26,8 +26,6 @@ During all publish operations, appropriate [lifecycle scripts](#lifecycle-script

Check out [Per-Package Configuration](#per-package-configuration) for more details about publishing scoped packages, custom registries, and custom dist-tags.

> If you're using [npm automation access token](https://docs.npmjs.com/creating-and-viewing-access-tokens#creating-access-tokens) please remember to [disable lerna access verification feature](#--no-verify-access). Automation token doesn't grant permissions needed for the verification to be successful. [Click here to read more about this issue](https://github.com/lerna/lerna/issues/2788).
## Positionals

### bump `from-git`
Expand Down Expand Up @@ -59,7 +57,7 @@ This is useful when a previous `lerna publish` failed to publish all packages to
- [`--legacy-auth`](#--legacy-auth)
- [`--no-git-reset`](#--no-git-reset)
- [`--no-granular-pathspec`](#--no-granular-pathspec)
- [`--no-verify-access`](#--no-verify-access)
- [`--verify-access`](#--verify-access)
- [`--otp`](#--otp)
- [`--preid`](#--preid)
- [`--pre-dist-tag <tag>`](#--pre-dist-tag-tag)
Expand Down Expand Up @@ -199,15 +197,14 @@ This option makes the most sense configured in lerna.json, as you really don't w

The root-level configuration is intentional, as this also covers the [identically-named option in `lerna version`](https://github.com/lerna/lerna/tree/main/commands/version#--no-granular-pathspec).

### `--no-verify-access`

By default, `lerna` will verify the logged-in npm user's access to the packages about to be published. Passing this flag will disable that check.
### `--verify-access`

If you are using a third-party registry that does not support `npm access ls-packages`, you will need to pass this flag (or set `command.publish.verifyAccess` to `false` in lerna.json).
By default, `lerna` will not verify the logged-in npm user's access to the packages about to be published. Passing this flag will cause `lerna` to proactively perform this verification before it attempts to publish any packages.

> Please use with caution
You should NOT use this option if:

> For the time being, use this flag/option always when you're handling NPM authorization with the use of [automation access token](https://docs.npmjs.com/creating-and-viewing-access-tokens#creating-access-tokens). [Click here to read more about this issue](https://github.com/lerna/lerna/issues/2788).
1. You are using a third-party registry that does not support `npm access ls-packages`
2. You are using an authentication token without read access, such as a [npm automation access token](https://docs.npmjs.com/creating-and-viewing-access-tokens#creating-access-tokens)

### `--otp`

Expand Down Expand Up @@ -297,6 +294,10 @@ Useful in [Continuous integration (CI)](https://en.wikipedia.org/wiki/Continuous

## Deprecated Options

### `--no-verify-access`

Access verification is now off by default, so `--no-verify-access` is not needed. To opt-in to access verification, use [`--verify-access`](#--verify-access).

### `--skip-npm`

Call [`lerna version`](https://github.com/lerna/lerna/tree/main/commands/version#readme) directly, instead.
Expand Down

0 comments on commit 512536f

Please sign in to comment.