From f0f908a8400fffcedb6a047430d19649a839dbba Mon Sep 17 00:00:00 2001 From: Sung Won Chung Date: Tue, 6 Feb 2024 11:02:40 -0800 Subject: [PATCH] more docs --- .github/workflows/dbt_deploy.yml | 2 ++ .github/workflows/dbt_staging.yml | 1 + README.md | 9 ++++++++- 3 files changed, 11 insertions(+), 1 deletion(-) diff --git a/.github/workflows/dbt_deploy.yml b/.github/workflows/dbt_deploy.yml index a1700be..0e8bead 100644 --- a/.github/workflows/dbt_deploy.yml +++ b/.github/workflows/dbt_deploy.yml @@ -41,6 +41,8 @@ jobs: SNOWFLAKE_PASSWORD: ${{ secrets.SNOWFLAKE_PASSWORD }} SNOWFLAKE_ROLE: ${{ secrets.SNOWFLAKE_ROLE }} + # TODO: comment this step out if you don't have Datafold Cloud yet + # TODO: replace --ci-config-id 345 with your unique datafold ci config id - name: submit artifacts to datafold run: | set -ex diff --git a/.github/workflows/dbt_staging.yml b/.github/workflows/dbt_staging.yml index 22fbc7f..e4ff4bd 100644 --- a/.github/workflows/dbt_staging.yml +++ b/.github/workflows/dbt_staging.yml @@ -55,6 +55,7 @@ jobs: SNOWFLAKE_ROLE: ${{ secrets.SNOWFLAKE_ROLE }} SNOWFLAKE_SCHEMA: "${{ format('{0}_{1}', 'PR_NUM', steps.findPr.outputs.pr) }}" + # TODO: comment this step out if you don't have Datafold Cloud yet # TODO: replace --ci-config-id 345 with your unique datafold ci config id - name: submit artifacts to datafold run: | diff --git a/README.md b/README.md index b853e1e..b33c56c 100644 --- a/README.md +++ b/README.md @@ -42,5 +42,12 @@ dbt build --target prod git checkout -b feature/your-feature ``` -7. Make some changes to your dbt models and push to your remote repository +7. Make some changes to your dbt models and push to your remote repository. You can copy and paste the examples here and run it locally: [example_dbt_changes](example_dbt_changes/) +```bash +dbt build +``` + +8. See your CI pipeline run and test your changes in your pull request + +9. Merge the pull request and watch as your changes are deployed to production and your staging schema is cleaned up