Skip to content

Commit

Permalink
docs: Clarify that $npm_package.publish requires publishable = True
Browse files Browse the repository at this point in the history
This fact is already mentioned further down in the docs, but this commit makes it more apparent when only scanning the summary.

The default value for `publishable` was changed in #1683.
  • Loading branch information
fweikert committed Sep 30, 2024
1 parent f0c67a2 commit e00378d
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/npm_package.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion npm/private/npm_package.bzl
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ def npm_package(
This target can be used as the `src` attribute to `npm_link_package`.
The macro also produces a target `[name].publish`, that can be run to publish to an npm registry.
With `publishable = True` the macro also produces a target `[name].publish`, that can be run to publish to an npm registry.
Under the hood, this target runs `npm publish`. You can pass arguments to npm by escaping them from Bazel using a double-hyphen,
for example: `bazel run //path/to:my_package.publish -- --tag=next`
Expand Down

0 comments on commit e00378d

Please sign in to comment.