updated github action jobs (#64)

This commit is contained in:
drethereum 2023-01-04 16:09:59 -07:00 committed by GitHub
parent 34a2b3d334
commit 796d9a35ef
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 124 additions and 136 deletions

View File

@ -1,74 +0,0 @@
# run-dbt-command in github action
## First time configuration
### Step 1: Checkout the main branch
- `git checkout main`
- switch to main branch firstly as we would like the update applied to main branch
- `git pull`
- pull the latest update in main branch to make it up-to-date
### Step 2: Create a new branch based on main for the upcoming merge
Reason we need to do this step is that the remote pushed branch doesn't have all the main branch information, we cannot easily just push that as it only contains the github workflow needed files
- `git checkout -b add-dbt-run-github-action-to-repo`
### Step 3: Checked out the changes
- `git checkout AN-2377-added-schedule-dbt-run-template-github-actions .github/workflows`:
- The updated files are sit under the branch `AN-2377-added-schedule-dbt-run-template-github-actions`, we only want to check out that folder containing this information
### Step 4: Submit PR and merge it to main
- `git add .`
- `git commit -m 'add the dbt run workflow to main branch`
- `git push`
- Submit the PR in Github for approval
### Step 5: Set up the repository secrets
Go to `Github Repo -> Settings -> Environments`, click create new environment, call it `workflow`, and then type in the following information one by one:
```yml
ACCOUNT:
DATABASE_DEV:
DATABASE_PROD:
PASSWORD:
REGION:
ROLE:
SCHEMA:
USER:
WAREHOUSE_DEV:
WAREHOUSE_PROD:
```
Here take axelar as an example for the information we need to type, basically it looks like the one we used in dbt cloud
```yml
ACCOUNT: vna27887.us-east-1
DATABASE_DEV: AXELAR_DEV
DATABASE_PROD: AXELAR
PASSWORD: userpassword
REGION: us-east-1
ROLE: DBT_CLOUD_AXELAR
SCHEMA: silver
USER: DBT_CLOUD_AXELAR
WAREHOUSE_DEV: DBT_CLOUD
WAREHOUSE_PROD: DBT_CLOUD
```
*screenshot for the location of the environment in the settings:*
![environment](./images/environment-settings.png)
*TODO: Here we will only keep the account credential here and move the basic settings to the template, like the account, warehouse etc.*
## Running Commands
### Run it as a scheduled job
Go to `dbt_run_scheduled.yml` file and there are 2 things need to be updated
- **scheduled cron**: updated it to what you want, 20 mins, 10 mins or 6 hours
- ![scheduled-cron](./images/scheduled-cron.png)
- **dbt commands**: updated it to the commands you want to run
- ![dbt-commands](./images/dbt-commands.png)
- Here are some commands samples:
- Run it in prod: `'["dbt run -m ./models/streamline/streamline__txs_history.sql --target prod"]'`
- Run multiple commands (It is going to be in parallel to speed up): `'["dbt run -m ./models/streamline/streamline__txs_history.sql --target prod", "dbt run -m ./models/streamline/streamline__blocks_history.sql --target prod"]'`
### Run it as an ad-hoc job
Go to the Action and click the dbt_run_adhoc and type in the command you want to run, please note here that the command you type cannot includ the `'` at beginning and end, it should look something like: `["dbt run -m ./models/streamline/streamline__txs_history.sql --target prod"]`
![ad-hoc-run](./images/ad-hoc-run.png)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 96 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.6 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 150 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 10 KiB

View File

@ -4,8 +4,25 @@ run-name: dbt_run_adhoc
on:
workflow_dispatch:
branches:
- main
- "main"
inputs:
environment:
type: choice
description: DBT Run Environment
required: true
options:
- dev
- prod
default: dev
warehouse:
type: choice
description: Snowflake warehouse
required: true
options:
- DBT
- DBT_CLOUD
- DBT_EMERGENCY
default: DBT
dbt_command:
type: string
description: 'DBT Run Command'
@ -19,17 +36,31 @@ env:
USER: "${{ secrets.USER }}"
PASSWORD: "${{ secrets.PASSWORD }}"
REGION: "${{ secrets.REGION }}"
DATABASE_DEV: "${{ secrets.DATABASE_DEV }}"
DATABASE_PROD: "${{ secrets.DATABASE_PROD }}"
WAREHOUSE_DEV: "${{ secrets.WAREHOUSE_DEV }}"
WAREHOUSE_PROD: "${{ secrets.WAREHOUSE_PROD }}"
DATABASE: "${{ secrets.DATABASE }}"
WAREHOUSE: "${{ inputs.warehouse }}"
SCHEMA: "${{ secrets.SCHEMA }}"
jobs:
called_workflow_template:
uses: FlipsideCrypto/analytics-workflow-templates/.github/workflows/dbt_run_template.yml@main
with:
dbt_command: ${{ inputs.dbt_command }}
secrets: inherit
run_dbt_jobs:
runs-on: ubuntu-latest
environment:
name: workflow_${{ inputs.environment }}
strategy:
matrix:
command: ${{fromJson(inputs.dbt_command)}}
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v1
with:
python-version: "3.7.x"
- name: install dependencies
run: |
pip3 install dbt-snowflake==1.3.0 cli_passthrough requests click
dbt deps
- name: Run DBT Jobs
run: |
${{ matrix.command }}

View File

@ -2,9 +2,7 @@ name: dbt_run_api_feeder_table
run-name: dbt_run_api_feeder_table
on:
push:
branches:
- main
workflow_dispatch:
schedule:
# Runs "at 8:00 UTC" (see https://crontab.guru)
- cron: '0 8 * * *'
@ -17,19 +15,28 @@ env:
USER: "${{ secrets.USER }}"
PASSWORD: "${{ secrets.PASSWORD }}"
REGION: "${{ secrets.REGION }}"
DATABASE_DEV: "${{ secrets.DATABASE_DEV }}"
DATABASE_PROD: "${{ secrets.DATABASE_PROD }}"
WAREHOUSE_DEV: "${{ secrets.WAREHOUSE_DEV }}"
WAREHOUSE_PROD: "${{ secrets.WAREHOUSE_PROD }}"
DATABASE: "${{ secrets.DATABASE }}"
WAREHOUSE: "${{ secrets.WAREHOUSE }}"
SCHEMA: "${{ secrets.SCHEMA }}"
jobs:
called_workflow_template:
uses: FlipsideCrypto/analytics-workflow-templates/.github/workflows/dbt_run_template.yml@main
with:
dbt_command: '["dbt run -m models/silver/api_udf"]'
secrets: inherit # pass all secrets
run_dbt_jobs:
runs-on: ubuntu-latest
environment:
name: workflow_prod
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v1
with:
python-version: "3.7.x"
- name: install dependencies
run: |
pip3 install dbt-snowflake==1.3.0 cli_passthrough requests click
dbt deps
- name: Run DBT Jobs
run: |
dbt run -m models/silver/api_udf

View File

@ -2,9 +2,7 @@ name: dbt_run_dev_refresh
run-name: dbt_run_dev_refresh
on:
push:
branches:
- main
workflow_dispatch:
schedule:
# Runs "at 9:00 UTC" (see https://crontab.guru)
- cron: '0 9 * * *'
@ -17,19 +15,28 @@ env:
USER: "${{ secrets.USER }}"
PASSWORD: "${{ secrets.PASSWORD }}"
REGION: "${{ secrets.REGION }}"
DATABASE_DEV: "${{ secrets.DATABASE_DEV }}"
DATABASE_PROD: "${{ secrets.DATABASE_PROD }}"
WAREHOUSE_DEV: "${{ secrets.WAREHOUSE_DEV }}"
WAREHOUSE_PROD: "${{ secrets.WAREHOUSE_PROD }}"
DATABASE: "${{ secrets.DATABASE }}"
WAREHOUSE: "${{ secrets.WAREHOUSE }}"
SCHEMA: "${{ secrets.SCHEMA }}"
jobs:
called_workflow_template:
uses: FlipsideCrypto/analytics-workflow-templates/.github/workflows/dbt_run_template.yml@main
with:
dbt_command: '["dbt run-operation run_sp_create_prod_clone"]'
secrets: inherit # pass all secrets
run_dbt_jobs:
runs-on: ubuntu-latest
environment:
name: workflow_prod
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v1
with:
python-version: "3.7.x"
- name: install dependencies
run: |
pip3 install dbt-snowflake==1.3.0 cli_passthrough requests click
dbt deps
- name: Run DBT Jobs
run: |
dbt run-operation run_sp_create_prod_clone

View File

@ -2,9 +2,7 @@ name: dbt_run_scheduled
run-name: dbt_run_scheduled
on:
push:
branches:
- main
workflow_dispatch:
schedule:
# Runs "every 2 hours" (see https://crontab.guru)
- cron: '0 */2 * * *'
@ -17,19 +15,28 @@ env:
USER: "${{ secrets.USER }}"
PASSWORD: "${{ secrets.PASSWORD }}"
REGION: "${{ secrets.REGION }}"
DATABASE_DEV: "${{ secrets.DATABASE_DEV }}"
DATABASE_PROD: "${{ secrets.DATABASE_PROD }}"
WAREHOUSE_DEV: "${{ secrets.WAREHOUSE_DEV }}"
WAREHOUSE_PROD: "${{ secrets.WAREHOUSE_PROD }}"
DATABASE: "${{ secrets.DATABASE }}"
WAREHOUSE: "${{ secrets.WAREHOUSE }}"
SCHEMA: "${{ secrets.SCHEMA }}"
jobs:
called_workflow_template:
uses: FlipsideCrypto/analytics-workflow-templates/.github/workflows/dbt_run_template.yml@main
with:
dbt_command: '["dbt run --exclude models/silver/api_udf"]'
secrets: inherit # pass all secrets
run_dbt_jobs:
runs-on: ubuntu-latest
environment:
name: workflow_prod
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v1
with:
python-version: "3.7.x"
- name: install dependencies
run: |
pip3 install dbt-snowflake==1.3.0 cli_passthrough requests click
dbt deps
- name: Run DBT Jobs
run: |
dbt run --exclude models/silver/api_udf

View File

@ -2,9 +2,7 @@ name: dbt_test
run-name: dbt_test
on:
push:
branches:
- main
workflow_dispatch:
schedule:
# Runs "at 9:00 UTC" (see https://crontab.guru)
- cron: '0 9 * * *'
@ -17,19 +15,31 @@ env:
USER: "${{ secrets.USER }}"
PASSWORD: "${{ secrets.PASSWORD }}"
REGION: "${{ secrets.REGION }}"
DATABASE_DEV: "${{ secrets.DATABASE_DEV }}"
DATABASE_PROD: "${{ secrets.DATABASE_PROD }}"
WAREHOUSE_DEV: "${{ secrets.WAREHOUSE_DEV }}"
WAREHOUSE_PROD: "${{ secrets.WAREHOUSE_PROD }}"
DATABASE: "${{ secrets.DATABASE }}"
WAREHOUSE: "${{ secrets.WAREHOUSE }}"
SCHEMA: "${{ secrets.SCHEMA }}"
jobs:
called_workflow_template:
uses: FlipsideCrypto/analytics-workflow-templates/.github/workflows/dbt_run_template.yml@main
with:
dbt_command: '["dbt test"]'
secrets: inherit # pass all secrets
run_dbt_jobs:
runs-on: ubuntu-latest
environment:
name: workflow_prod
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v1
with:
python-version: "3.7.x"
- name: install dependencies
run: |
pip3 install dbt-snowflake==1.3.0 cli_passthrough requests click
dbt deps
- name: Run DBT Jobs
run: |
dbt test