Skip to content

Whenever you make a change to a dbt model, Atlan will add downstream lineage impact context right in your pull requests.

License

Notifications You must be signed in to change notification settings

atlanhq/dbt-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date
Jan 12, 2023
Jan 18, 2023
Jan 18, 2023
Dec 7, 2022
Nov 23, 2022
Dec 24, 2022
Nov 23, 2022
Jan 16, 2023
Nov 23, 2022
Dec 29, 2022
Nov 28, 2022
Nov 28, 2022

Repository files navigation

Atlan dbt Action

atlan<>dbt

Overview

Have you ever changed a dbt model only to later find it broke a downstream table or dashboard? πŸ’”

We've created a GitHub Action to help you out β€” putting Atlan's impact analysis right into your pull request. So now, before merging the PR, you can see the potential downstream impact of your changes.

Here's what it looks like πŸ‘‡

GitHub Action comment screenshot

Prerequisites

  • Atlan API token β†’ before you can run the action, you need an Atlan API token.

Configure the action

  1. Create repository secrets in your repository:

    • ATLAN_INSTANCE_URL with the URL of your Atlan instance.
    • ATLAN_API_TOKEN with the value of the API token.

    Actions Secrets Screenshot

  2. Add the GitHub Action to your workflow:

    1. Create a workflow file in your repository: .github/workflows/atlan-dbt.yml

    2. Add the following code to the workflow file:

      name: Atlan dbt action
      
      on:
        pull_request:
          types: [opened, edited, synchronize, reopened, closed]
      
      jobs:
        get-downstream-impact:
          name: Get Downstream Assets
          runs-on: ubuntu-latest
          steps:
            - name: Run Action
              uses: atlanhq/dbt-action@v1-beta
              with:
                GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
                ATLAN_INSTANCE_URL: ${{secrets.ATLAN_INSTANCE_URL}}
                ATLAN_API_TOKEN: ${{secrets.ATLAN_API_TOKEN}}

Test the action

To test the action, after you've completed the configuration above create a pull request with a changed dbt model file. You should see the Atlan GitHub action running and then adding comments in your pull request.

Inputs

Name Description Required
GITHUB_TOKEN Needed to write comments on PRs to print all the downstream assets. https://dev.to/github/the-githubtoken-in-github-actions-how-it-works-change-permissions-customizations-3cgp true
ATLAN_INSTANCE_URL Needed for making API requests to the user's tenant. true
ATLAN_API_TOKEN Needed for authenticating API requests to the user's tenant. https://ask.atlan.com/hc/en-us/articles/8312649180049 true