README.md

Lightdash GitHub Actions templates

Deploy your Lightdash project

deploy.yml

Follow the Lightdash documentation to know how you can add this Github action to your DBT Github repo to automatically deploy your DBT changes into Lightdash.

Refresh your Lightdash project

refresh.yml

Alternative to deploy.yml. The main difference is that it uses the credentials saved in your Lightdash project.

Compile your dbt project

compile.yml

Succeeds if your dbt project compiles correctly.

Create a preview Lightdash project on each pull request

start-preview.yml stop-preview.yml

Follow the Lightdash documentation to know how you can add this Github action to your DBT Github repo to automatically create preview projects with your pull request changes.

Extra configuration

Use CLI config instead of ENV vars

If you prefer to authenticate on the CLI using the lightdash/config.yaml file, just copy the full content of that file into a CLI_CONFIG secret

and add the following step before Lightdash CLI deploy

      - name: Create config file 
        env: 
          config: ${{ secrets.CLI_CONFIG }}          
        run:  |
          mkdir -p $HOME/.config/lightdash
          echo -e "$config" > $HOME/.config/lightdash/config.yaml

Both options are compatible (env vars have priority)