Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(builtin): use npm ci as default behaviour for installing node_modules #2328

Merged
merged 2 commits into from
Dec 18, 2020
Merged

feat(builtin): use npm ci as default behaviour for installing node_modules #2328

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
887c496
feat(builtin): use npm ci as default behaviour for installing node_mo…
Dec 2, 2020
9e11366
cleanup
Dec 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions WORKSPACE
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,7 @@ npm_install(
".json",
".proto",
],
npm_command = "install",
package_json = "//:tools/fine_grained_deps_npm/package.json",
package_lock_json = "//:tools/fine_grained_deps_npm/package-lock.json",
symlink_node_modules = False,
Expand Down
5 changes: 5 additions & 0 deletions internal/bazel_integration_test/test_runner.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,11 @@ if (config.bazelrcAppend) {
workspaceContents =
workspaceContents.replace(/(yarn_lock[\s\S]+?,)/gm, 'frozen_lockfile = False,\n $1')

// We have to use npm install in favour of npm ci as the package-lock.json would not match the
// replaced version
workspaceContents = workspaceContents.replace(
/(package_lock_json[\s\S]+?,)/gm, 'npm_command = "install",\n $1')

if (!workspaceContents.includes(archiveFile)) {
console.error(
`bazel_integration_test: WORKSPACE replacement for repository ${repositoryKey} failed!`)
Expand Down
17 changes: 16 additions & 1 deletion internal/npm_install/npm_install.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,11 @@ def _npm_install_impl(repository_ctx):
is_windows_host = is_windows_os(repository_ctx)
node = repository_ctx.path(get_node_label(repository_ctx))
npm = get_npm_label(repository_ctx)
npm_args = ["install"] + repository_ctx.attr.args

# Set the base command (install or ci)
npm_args = [repository_ctx.attr.npm_command]

npm_args.extend(repository_ctx.attr.args)

# If symlink_node_modules is true then run the package manager
# in the package.json folder; otherwise, run it in the root of
Expand Down Expand Up @@ -303,6 +307,17 @@ npm_install = repository_rule(
See npm CLI docs https://docs.npmjs.com/cli/install.html for complete list of supported arguments.""",
default = [],
),
"npm_command": attr.string(
default = "ci",
doc = """The npm command to run, to install dependencies.

See npm docs <https://docs.npmjs.com/cli/v6/commands>

In particular, for "ci" it says:
> If dependencies in the package lock do not match those in package.json, npm ci will exit with an error, instead of updating the package lock.
""",
values = ["ci", "install"],
),
"package_lock_json": attr.label(
mandatory = True,
allow_single_file = True,
Expand Down