Clarify predictable package installs and git packages #4981
Labels
content
Improvements or additions to content
improvement
Use this when an area of the docs needs improvement as it's currently unclear
Contributions
Link to the page on docs.getdbt.com requiring updates
This was raised by our mighty support team in slack:
From Kyle:
Something in our docs led to a bit of confusion with a customer, and I wanted to ask for clarification.
About dbt deps command - Predictable package installs -- "dbt generates a package-lock.yml file in the root of your project. This contains the complete set of resolved packages based on the packages configuration in dependencies.yml or packages.yml. Each subsequent invocation of dbt deps will install from the locked set of packages specified in this file"
Packages - Git packages -- "If you use master, then any updates to the package will be incorporated into your project the next time you run dbt deps"
My understanding is that the "Predictable Package Installs" doc is accurate, and the omission of the package-lock.yml file concept in the "Git Packages" doc is not technically wrong but is a bit confusing.
What part(s) of the page would you like to see updated?
From reading it, it sounds like they’re diff mechanisms to managed packages and leaves it up to the user to decide whether they want stability or flexibility. it sounds like the packages page should explicitly mention how this interacts with package-lock.yml
both pages would benefit from mentioning their relation to each other:
https://docs.getdbt.com/docs/build/packages#git-packages
https://docs.getdbt.com/reference/commands/deps#predictable-package-installs
We should also update the language to replace
master
tomain
.Additional information
No response
The text was updated successfully, but these errors were encountered: