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.

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

Update cloud-cli-installation.md #6799

Merged
merged 16 commits into from
Feb 20, 2025
Merged

Update cloud-cli-installation.md #6799

merged 16 commits into from
Feb 20, 2025

Conversation

jeremyyeo
Copy link
Contributor

@jeremyyeo jeremyyeo commented Jan 20, 2025

What are you changing in this pull request and why?

Making users aware of limitation https://dbt-labs.slack.com/archives/C019QLR6EJE/p1721233164421329

Checklist

  • I have reviewed the Content style guide so my content adheres to these guidelines.
  • The topic I'm writing about is for specific dbt version(s) and I have versioned it according to the version a whole page and/or version a block of content guidelines.
  • I have added checklist item(s) to this list for anything anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch."
  • The content in this PR requires a dbt release note, so I added one to the release notes page.

🚀 Deployment available! Here are the direct links to the updated files:

@jeremyyeo jeremyyeo requested a review from a team as a code owner January 20, 2025 21:50
Copy link

vercel bot commented Jan 20, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
docs-getdbt-com ✅ Ready (Inspect) Visit Preview Feb 20, 2025 0:11am

@github-actions github-actions bot added content Improvements or additions to content size: small This change will take 1 to 2 days to address labels Jan 20, 2025
@mirnawong1
Copy link
Contributor

hey @jeremyyeo ! thanks for opening this up. how does the below sound so there's more context:

The dbt Cloud CLI doesn't currently support relative paths in the packages.yml file. This mostly applies to organizations that use a monorepo structure.

For example, trying to reference the shared_macros directory from your packages.yml file like this won't work:

# repository_root/my_dbt_project_in_a_subdirectory/packages.yml

packages:
  - local: ../shared_macros

In this example, ../shared_macros is a relative path that tells dbt to look for:

  • .. — Go one directory up (to repository_root).
  • /shared_macros — Find the shared_macros folder in the root directory.

To work around this limitation:

  • Use the dbt Cloud IDE to support relative paths for this use case.
  • If using a monorepo with multiple projects as subdirectories, use private packages or the git clone method to share package across projects.
  • If using monorepo with single project, store the package in the same repository as the project.


To work around this limitation:
- Use the [dbt Cloud IDE](/docs/cloud/dbt-cloud-ide/develop-in-the-cloud), which supports relative paths for this use case.
- If using a monorepo with multiple projects as subdirectories, use [private packages](/docs/build/packages#private-packages) or the [git clone method](/docs/build/packages#ssh-key-method-command-line-only) to share package across projects.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you test if private packages works with dbt Cloud CLI? Not sure at the top of my head :)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i didn't but i was having a chat with Lucas Silbernagel about this and that's here i got it from. should i juts remove that bullet and just let users know to use the ide??

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok @jeremyyeo , changed it to this:

The dbt Cloud CLI doesn't currently support relative paths in the packages.yml file.

For example, trying to install a local package (shared_macros directory) in your packages.yml file won't work:

# repository_root/my_dbt_project_in_a_subdirectory/packages.yml

packages:
  - local: ../shared_macros

In this example, ../shared_macros is a relative path that tells dbt to look for:

  • .. — Go one directory up (to repository_root).
  • /shared_macros — Find the shared_macros folder in the root directory.

To work around this limitation, use the dbt Cloud IDE, which supports relative paths for this use case.

@mirnawong1 mirnawong1 self-assigned this Feb 6, 2025
@mirnawong1
Copy link
Contributor

hey @jeremyyeo , ok how's this looking now:

Screenshot 2025-02-14 at 11 17 00

@mirnawong1
Copy link
Contributor

confirmed by Jeremy!

@mirnawong1 mirnawong1 enabled auto-merge February 20, 2025 12:09
@mirnawong1 mirnawong1 merged commit 3fe6ca8 into current Feb 20, 2025
8 checks passed
@mirnawong1 mirnawong1 deleted the jeremyyeo-patch-3 branch February 20, 2025 12:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content size: small This change will take 1 to 2 days to address
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants