Skip to content

Commit e39ffb9

Browse files
authored
Update README.md
1 parent 17a60f0 commit e39ffb9

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

README.md

+7-8
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,27 @@
1-
# Fal dbt Cloud action
1+
# dbt Cloud action
22

3-
This action manages a job run on [dbt Cloud](https://cloud.getdbt.com) and fetches job artifacts.
3+
This action lets you trigger a job run on [dbt Cloud](https://cloud.getdbt.com), fetches the `run_results.json` artifact, and `git checkout`s the branch that was ran by dbt Cloud.
44

55
### Inputs
66
**Required**:
77
- `dbt_cloud_token` - dbt Cloud [api token](https://docs.getdbt.com/docs/dbt-cloud/dbt-cloud-api/user-tokens)
88
- `dbt_cloud_account_id` - dbt Cloud account id
99
- `dbt_cloud_job_id` - dbt Cloud job id
10-
- `profiles` - contents of a [profiles.yml](https://docs.getdbt.com/reference/profiles.yml/) as a string
11-
- `keyfile` - Contents of a data warehouse keyfile
10+
- `profiles` - contents of a [profiles.yml](https://docs.getdbt.com/reference/profiles.yml/) as a string. (Please inline the keyfile [as seen in the example](https://docs.getdbt.com/reference/warehouse-profiles/bigquery-profile#service-account-json).)
11+
12+
We recommend passing sensitive variables as Github secrets. Example [here](https://github.com/fal-ai/fal_bike_example/blob/main/.github/workflows/fal_dbt.yml).
1213

1314
**Optional**:
1415
- `cause` - Cause message to use [Default=`"Triggered by a GitHub Action"`]
1516
- `interval` - The interval between polls in seconds [Default=`30`]
16-
- `profile_name` - Name of target profile [Default=`default`]
17-
- `output_name` - Profile output [Default=`dev`]
1817

1918
### Example usage
2019
```yaml
21-
- uses: fal-ai/fal_dbt_cloud_action@v0.1
20+
- uses: fal-ai/dbt-cloud-action@v0.1
2221
id: dbt_cloud_run
2322
with:
2423
dbt_cloud_token: ${{ secrets.DBT_CLOUD_API_TOKEN }}
2524
dbt_cloud_account_id: ${{ secrets.DBT_ACCOUNT_ID }}
2625
dbt_cloud_job_id: ${{ secrets.DBT_JOB_ID }}
27-
profiles: ${{ secrets.PROFILES_YML }}
26+
dbt_profiles: ${{ secrets.PROFILES_YML }}
2827
```

0 commit comments

Comments
 (0)