Skip to content

Commit

Permalink
fix(docs): update npm-publish access flag info
Browse files Browse the repository at this point in the history
PR-URL: #3630
Credit: @austincho
Close: #3630
Reviewed-by: @wraithgar

EDIT(@isaacs): rebased and edited to put config documentation in the
correct location.
  • Loading branch information
austincho authored and isaacs committed Aug 19, 2021
1 parent b6f40b5 commit ff6626a
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/content/commands/npm-publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,12 @@ If you want your scoped package to be publicly viewable (and installable)
set `--access=public`. The only valid values for `access` are `public` and
`restricted`. Unscoped packages _always_ have an access level of `public`.
Note: Using the `--access` flag on the `npm publish` command will only set
the package access level on the initial publish of the package. Any
subsequent `npm publish` commands using the `--access` flag will not have an
effect to the access level. To make changes to the access level after the
initial publish use `npm access`.
<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->
Expand Down
6 changes: 6 additions & 0 deletions docs/content/using-npm/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,12 @@ If you want your scoped package to be publicly viewable (and installable)
set `--access=public`. The only valid values for `access` are `public` and
`restricted`. Unscoped packages _always_ have an access level of `public`.

Note: Using the `--access` flag on the `npm publish` command will only set
the package access level on the initial publish of the package. Any
subsequent `npm publish` commands using the `--access` flag will not have an
effect to the access level. To make changes to the access level after the
initial publish use `npm access`.

<!-- automatically generated, do not edit manually -->
<!-- see lib/utils/config/definitions.js -->

Expand Down
6 changes: 6 additions & 0 deletions lib/utils/config/definitions.js
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,12 @@ define('access', {
(and installable) set \`--access=public\`. The only valid values for
\`access\` are \`public\` and \`restricted\`. Unscoped packages _always_
have an access level of \`public\`.
Note: Using the \`--access\` flag on the \`npm publish\` command will only
set the package access level on the initial publish of the package. Any
subsequent \`npm publish\` commands using the \`--access\` flag will not
have an effect to the access level. To make changes to the access level
after the initial publish use \`npm access\`.
`,
flatten,
})
Expand Down

0 comments on commit ff6626a

Please sign in to comment.