Skip to content

Commit

Permalink
Merge branch 'current' into mirnawong1-patch-21
Browse files Browse the repository at this point in the history
  • Loading branch information
matthewshaver authored Oct 24, 2023
2 parents d63c776 + 90b08e0 commit 6b9bd81
Show file tree
Hide file tree
Showing 5 changed files with 47 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ import AvailIntegrations from '/snippets/_sl-partner-links.md';
You can also integrate the following tools with the dbt Semantic Layer:
- [Push.ai](https://docs.push.ai/semantic-layer-integrations/dbt-semantic-layer)
- [Delphi](delphihq.com)
- KlipFolio Power Metrics - Documentation coming soon

### Custom integration

Expand Down
21 changes: 15 additions & 6 deletions website/docs/faqs/Environments/custom-branch-settings.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: How do I use the `Custom Branch` settings in a dbt Cloud Environment?
title: How do I use the 'Custom Branch' settings in a dbt Cloud Environment?
description: "Use custom code from your repository"
sidebar_label: 'Custom Branch settings'
sidebar_label: 'Custom branch settings'
id: custom-branch-settings
---

Expand All @@ -15,12 +15,21 @@ To specify a custom branch:

## Development

In a development environment, the default branch (commonly the `main` branch) is a read-only branch found in the IDE's connected repositories, which you can use to create development branches. Identifying a custom branch overrides this default behavior. Instead, your custom branch becomes read-only and can be used to create development branches. You will no longer be able to make commits to the custom branch from within the dbt Cloud IDE.
In a development environment, the default branch (usually named `main`) is a read-only branch in your connected repositories, which allows you to create new branches for development from it.

For example, you can use the `develop` branch of a connected repository. Edit an environment, select **Only run on a custom branch** in **General settings** , enter **develop** as the name of your custom branch.
Specifying a **Custom branch** overrides the default behavior. It makes the custom branch 'read-only' and enables you to create new development branches from it. This also means you can't edit this custom branch directly.

<Lightbox src="/img/docs/dbt-cloud/cloud-configuring-dbt-cloud/dev-environment-custom-branch.png" title="Configuring a custom base repository branch"/>
Only one branch can be read-only, which means when you set up a custom branch, your `main` branch (usually read-only) becomes editable. If you want to protect the `main` branch and prevent any commits on it, you need to set up branch protection rules in your git provider settings. This ensures your `main` branch remains secure and no new commits can be made to it.

For example, if you want to use the `develop` branch of a connected repository:

- Go to an environment and select **Settings** to edit it
- Select **Only run on a custom branch** in **General settings**
- Enter **develop** as the name of your custom branch
- Click **Save**

<Lightbox src="/img/docs/dbt-cloud/cloud-configuring-dbt-cloud/dev-environment-custom-branch.png" width="70%" title="Configuring a custom base repository branch"/>

## Deployment

When running jobs in a deployment environment, dbt will clone your project from your connected repository before executing your models. By default, dbt uses the default branch of your repository (commonly the `main` branch). To specify a different version of your project for dbt to execute during job runs in a particular environment, you can edit the Custom Branch setting as shown in the previous steps.
When running jobs in a deployment environment, dbt will clone your project from your connected repository before executing your models. By default, dbt uses the default branch of your repository (commonly the `main` branch). To specify a different version of your project for dbt to execute during job runs in a particular environment, you can edit the Custom Branch setting as shown in the previous steps.
14 changes: 14 additions & 0 deletions website/snippets/_sl-partner-links.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,20 @@ The following tools integrate with the dbt Semantic Layer:
</a>
</div>

<div className="card-container">
<Card
title="KlipFolio Power Metrics"
body="Refer to KlipFolio's documentation to learn how to connect, and deliver a streamlined metrics catalog to your business users."
link="https://support.klipfolio.com/hc/en-us/articles/18164546900759-PowerMetrics-Adding-dbt-Semantic-Layer-metrics"
icon="klipfolio"/>
<a href="https://support.klipfolio.com/hc/en-us/articles/18164546900759-PowerMetrics-Adding-dbt-Semantic-Layer-metrics"
className="external-link"
target="_blank"
rel="noopener noreferrer">
<i className="fa fa-external-link"></i>
</a>
</div>

<div className="card-container">
<Card
title="Lightdash"
Expand Down
9 changes: 9 additions & 0 deletions website/static/img/icons/klipfolio.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions website/static/img/icons/white/klipfolio.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6b9bd81

Please sign in to comment.