From e68dafa9cf383f405b694dd2cb639058878c5003 Mon Sep 17 00:00:00 2001 From: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> Date: Tue, 21 Nov 2023 17:38:42 -0500 Subject: [PATCH 1/4] Updating deps command page --- website/docs/reference/commands/deps.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/website/docs/reference/commands/deps.md b/website/docs/reference/commands/deps.md index 60ccd091ad7..1a9314987d9 100644 --- a/website/docs/reference/commands/deps.md +++ b/website/docs/reference/commands/deps.md @@ -62,7 +62,9 @@ Update your versions in packages.yml, then run dbt deps dbt generates the `package-lock.yml` file in the _project_root_ where `packages.yml` is recorded, which contains all the resolved packages, the first time you run `dbt deps`. Each subsequent run records the packages installed in this file. If the subsequent `dbt deps` runs contain no updated packages in `dependencies.yml` or `packages.yml`, dbt-core installs from `package-lock.yml`. -When you update the package spec and run `dbt deps` again, the package-lock and package files update accordingly. You can run `dbt deps --lock` to update the `package-lock.yml` with the most recent dependencies from `packages`. +When you update the package spec and run `dbt deps` again, the `package-lock.yml` and `packages.yml` files update accordingly. There are two flags for the `package-lock.yml`: +- `dbt deps --upgrade` — creates or updates the `package-lock.yml` with the most recent dependencies from `packages.yml` and installs them. +- `dbt deps --lock` — creates or updates the `package-lock.yml` but does not install the packages. The `--add-package` flag allows you to add a package to the `packages.yml` with configurable `--version` and `--source` information. The `--dry-run` flag, when set to `False`(default), recompiles the `package-lock.yml` file after a new package is added to the `packages.yml` file. Set the flag to `True` for the changes to not persist. From 3c3d28c543b1dc91d5f0e874471927c27724472b Mon Sep 17 00:00:00 2001 From: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> Date: Tue, 21 Nov 2023 17:43:27 -0500 Subject: [PATCH 2/4] updating spacing --- website/docs/reference/commands/deps.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/website/docs/reference/commands/deps.md b/website/docs/reference/commands/deps.md index 1a9314987d9..ddd3e4acb8e 100644 --- a/website/docs/reference/commands/deps.md +++ b/website/docs/reference/commands/deps.md @@ -62,7 +62,9 @@ Update your versions in packages.yml, then run dbt deps dbt generates the `package-lock.yml` file in the _project_root_ where `packages.yml` is recorded, which contains all the resolved packages, the first time you run `dbt deps`. Each subsequent run records the packages installed in this file. If the subsequent `dbt deps` runs contain no updated packages in `dependencies.yml` or `packages.yml`, dbt-core installs from `package-lock.yml`. -When you update the package spec and run `dbt deps` again, the `package-lock.yml` and `packages.yml` files update accordingly. There are two flags for the `package-lock.yml`: +When you update the package spec and run `dbt deps` again, the `package-lock.yml` and `packages.yml` files update accordingly. + +There are two flags related to `package-lock.yml`: - `dbt deps --upgrade` — creates or updates the `package-lock.yml` with the most recent dependencies from `packages.yml` and installs them. - `dbt deps --lock` — creates or updates the `package-lock.yml` but does not install the packages. From cfd3f8492606ac25cbaa5cf55287092f651886f0 Mon Sep 17 00:00:00 2001 From: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> Date: Tue, 21 Nov 2023 17:44:20 -0500 Subject: [PATCH 3/4] Apply suggestions from code review --- website/docs/reference/commands/deps.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/reference/commands/deps.md b/website/docs/reference/commands/deps.md index ddd3e4acb8e..40d9ee1cabd 100644 --- a/website/docs/reference/commands/deps.md +++ b/website/docs/reference/commands/deps.md @@ -65,8 +65,8 @@ dbt generates the `package-lock.yml` file in the _project_root_ where `packages. When you update the package spec and run `dbt deps` again, the `package-lock.yml` and `packages.yml` files update accordingly. There are two flags related to `package-lock.yml`: -- `dbt deps --upgrade` — creates or updates the `package-lock.yml` with the most recent dependencies from `packages.yml` and installs them. -- `dbt deps --lock` — creates or updates the `package-lock.yml` but does not install the packages. +- `dbt deps --upgrade` — creates or updates the `package-lock.yml` file with the most recent dependencies from `packages.yml` and installs them. +- `dbt deps --lock` — creates or updates the `package-lock.yml` file but does not install the packages. The `--add-package` flag allows you to add a package to the `packages.yml` with configurable `--version` and `--source` information. The `--dry-run` flag, when set to `False`(default), recompiles the `package-lock.yml` file after a new package is added to the `packages.yml` file. Set the flag to `True` for the changes to not persist. From 3ef39fbf6234a2de2c1d043db55611bea0352004 Mon Sep 17 00:00:00 2001 From: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> Date: Mon, 11 Dec 2023 16:12:43 -0500 Subject: [PATCH 4/4] Update website/docs/reference/commands/deps.md Co-authored-by: Doug Beatty <44704949+dbeatty10@users.noreply.github.com> --- website/docs/reference/commands/deps.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/reference/commands/deps.md b/website/docs/reference/commands/deps.md index 40d9ee1cabd..1a3562e3172 100644 --- a/website/docs/reference/commands/deps.md +++ b/website/docs/reference/commands/deps.md @@ -65,8 +65,8 @@ dbt generates the `package-lock.yml` file in the _project_root_ where `packages. When you update the package spec and run `dbt deps` again, the `package-lock.yml` and `packages.yml` files update accordingly. There are two flags related to `package-lock.yml`: -- `dbt deps --upgrade` — creates or updates the `package-lock.yml` file with the most recent dependencies from `packages.yml` and installs them. -- `dbt deps --lock` — creates or updates the `package-lock.yml` file but does not install the packages. +- `dbt deps --lock` — creates or updates the `package-lock.yml` file but does not install the packages. +- `dbt deps --upgrade` — creates or updates the `package-lock.yml` file with the most recent dependencies from `packages.yml`. Also install the packages unless the `--lock` flag is also passed. The `--add-package` flag allows you to add a package to the `packages.yml` with configurable `--version` and `--source` information. The `--dry-run` flag, when set to `False`(default), recompiles the `package-lock.yml` file after a new package is added to the `packages.yml` file. Set the flag to `True` for the changes to not persist.