https://github.com/lightdash/cli-actions
CLI scripts for Github actions
https://github.com/lightdash/cli-actions
Last synced: 12 months ago
JSON representation
CLI scripts for Github actions
- Host: GitHub
- URL: https://github.com/lightdash/cli-actions
- Owner: lightdash
- Created: 2022-09-14T07:15:23.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T19:26:07.000Z (about 2 years ago)
- Last Synced: 2025-06-09T04:02:40.324Z (12 months ago)
- Size: 42 KB
- Stars: 2
- Watchers: 12
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Lightdash GitHub Actions templates
## Deploy your Lightdash project
> deploy.yml
Follow the [Lightdash documentation](https://docs.lightdash.com/references/syncing_your_dbt_changes) 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](https://docs.lightdash.com/guides/cli/how-to-use-lightdash-preview#set-up-developer-previews-on-your-pull-requests) 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)