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

clarify ado behavior #6705

Open
wants to merge 5 commits into
base: current
Choose a base branch
from
+22 −4
Open

clarify ado behavior #6705

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e5689d0
clarify ado behavior
mirnawong1 Dec 20, 2024
f741d87
Update website/docs/docs/build/packages.md
mirnawong1 Dec 20, 2024
ab8fd7a
Merge branch 'current' into mirnawong1-patch-28
mirnawong1 Dec 20, 2024
b5ac123
Update packages.md
mirnawong1 Dec 20, 2024
d675e8f
Merge branch 'current' into mirnawong1-patch-28
mirnawong1 Dec 23, 2024
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
26 changes: 22 additions & 4 deletions website/docs/docs/build/packages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,19 +173,37 @@ To use native private packages, you must have one of the following Git providers

#### Configuration

Use the `private` key in your `packages.yml` or `dependencies.yml` to clone package repos using your existing dbt Cloud Git integration without having to provision an access token or create a dbt Cloud environment variable:
Use the `private` key in your `packages.yml` or `dependencies.yml` to clone package repos using your existing dbt Cloud Git integration without having to provision an access token or create a dbt Cloud environment variable.

The private key supports a two-layered-path: `org/repo`. dbt inherits the project path from your source repository.

<File name="packages.yml">

```yaml
packages:
- private: dbt-labs/awesome_repo
- private: dbt-labs/awesome_repo # your-org/your-repo path
- package: normal packages

[...]
[...]
```
</File>

:::tip Azure DevOps repositories
Normally ADO repos use the `org_name/project_name/repo_name` path. However, private package supports only the `org/repo` path. If the ADO package repository is within the same project as your source repository, you can specify `org/repo` in the `private` key. If the package repository _isn't_ within the same project as your source repository, then the private packages feature won't currently work:

<File name="packages.yml">

```yaml
packages:
- private: my-org/my-repo # Works if your ADO source repo and package repo are in the same project
```
</File>
:::

For Azure DevOps repositories, you can only specify the `org/repo` path. The project tier is inherited from the source repository currently integrated with dbt Cloud.

- If the package repository is within the same project as your source repository, you’re in the clear. Simply specify org/repo in the private block.
- If the package repository is not within the same project as your source repository, this feature will not work for you until a future update.
- This currently only works within a single Azure DevOps project. If your repositories are in different projects within the same organization, you can't reference them in the `private` key at this time.
Comment on lines +202 to +206
Copy link
Contributor

Choose a reason for hiding this comment

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

Could we add this as a "Prerequisite" of the feature? That, for ADO, the repo is located within the same org/project as your project's repo.


You can pin private packages similar to regular dbt packages:

Expand Down
Loading