updates

.github/workflows/examples.yml

@@ -0,0 +1,126 @@
+name: Test sdf-action
+
+on:
+  pull_request:
+
+jobs:
+  tpch_redshift:
+    runs-on: ubuntu-latest
+    name: Redshift workspace
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: sdf compile step
+        uses: ./ # Uses an action in the root directory
+        id: sdf
+        with:
+          command: 'sdf compile --show all'
+          workspace_dir: 'workspace/tpch_redshift'
+
+          aws_region: 'us-west-2'
+          aws_access_key_id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws_secret_access_key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+
+      # Use the output from the `sdf` step
+      - name: Display the sdf output
+        run: |
+          echo "### SDF Run Logs 🪵" >> $GITHUB_STEP_SUMMARY
+          echo '```' >>$GITHUB_STEP_SUMMARY
+          echo "${{ steps.sdf.outputs.log }}" >>$GITHUB_STEP_SUMMARY
+          echo '```' >>$GITHUB_STEP_SUMMARY
+
+  # dbt_init_challenge_v1 - uses dbt-action
+  dbt_init_challenge_v1:
+    runs-on: ubuntu-latest
+    name: Snowflake + dbt workspace - run dbt commands using dbt-action
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Run DBT commands
+        uses: mwhitaker/dbt-action@master
+        env: 
+          DBT_TARGET: dev
+          SNOWFLAKE_ACCOUNT_ID: ${{ secrets.SNOWFLAKE_ACCOUNT_ID }}
+          SNOWFLAKE_PASSWORD: ${{ secrets.SNOWFLAKE_PASSWORD }}
+        with:
+          dbt_command: "dbt compile"
+          dbt_project_folder: "workspace/dbt_init_challenge"
+
+      - name: Run sdf compile
+        uses: ./ # Uses an action in the root directory
+        id: sdf
+        env:
+          CATALOG: dbt_hol_dev
+          SCHEMA: public
+        with:
+          command: 'sdf compile'
+          workspace_dir: 'workspace/dbt_init_challenge'
+          access_key: ${{ secrets.ACCESS_KEY }}
+          secret_key: ${{ secrets.SECRET_KEY }}
+
+          is_dbt: 'true'
+          snowflake_account_id: ${{ secrets.SNOWFLAKE_ACCOUNT_ID }}
+          snowflake_username: ${{ secrets.SNOWFLAKE_USERNAME }}
+          snowflake_password: ${{ secrets.SNOWFLAKE_PASSWORD }}
+          snowflake_role: 'dbt_test_role'
+          snowflake_warehouse: 'dbt_dev_wh'
+
+      # Use the output from the `sdf` step
+      - name: Display the sdf output
+        run: |
+          echo "### SDF Run Logs 🪵" >> $GITHUB_STEP_SUMMARY
+          echo '```' >>$GITHUB_STEP_SUMMARY
+          echo "${{ steps.sdf.outputs.log }}" >>$GITHUB_STEP_SUMMARY
+          echo '```' >>$GITHUB_STEP_SUMMARY
+
+  # dbt_init_challenge_v2: rus dbt commands in a container job
+  dbt_init_challenge_v2:
+    container:
+      image: ghcr.io/dbt-labs/dbt-snowflake:1.5.latest
+      volumes:
+        - ${{ github.workspace }}:/repo
+
+    runs-on: ubuntu-latest
+    name: Snowflake + dbt workspace - run dbt commands in a container job
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Run DBT commands
+        env:
+          DBT_TARGET: dev
+          SNOWFLAKE_ACCOUNT_ID: ${{ secrets.SNOWFLAKE_ACCOUNT_ID }}
+          SNOWFLAKE_PASSWORD: ${{ secrets.SNOWFLAKE_PASSWORD }}
+        run: |
+          cd /repo/workspace/dbt_init_challenge
+          dbt deps
+          dbt compile
+      - name: Run sdf push
+        uses: ./ # Uses an action in the root directory
+        id: sdf
+        env:
+          CATALOG: dbt_hol_dev
+          SCHEMA: public
+        with:
+          command: 'sdf push'
+          # relative path to ${{ github.workspace }} which is automatically mounted by GitHub Actions
+          workspace_dir: workspace/dbt_init_challenge
+          access_key: ${{ secrets.ACCESS_KEY }}
+          secret_key: ${{ secrets.SECRET_KEY }}
+
+          is_dbt: 'true'
+          snowflake_account_id: ${{ secrets.SNOWFLAKE_ACCOUNT_ID }}
+          snowflake_username: ${{ secrets.SNOWFLAKE_USERNAME }}
+          snowflake_password: ${{ secrets.SNOWFLAKE_PASSWORD }}
+          snowflake_role: 'dbt_test_role'
+          snowflake_warehouse: 'dbt_dev_wh'
+
+      # Use the output from the `sdf` step
+      - name: Display the sdf output
+        run: |
+          echo "### SDF Run Logs 🪵" >> $GITHUB_STEP_SUMMARY
+          echo '```' >>$GITHUB_STEP_SUMMARY
+          echo "${{ steps.sdf.outputs.log }}" >>$GITHUB_STEP_SUMMARY
+          echo '```' >>$GITHUB_STEP_SUMMARY
+

Dockerfile

@@ -1,22 +1,19 @@
 FROM python:3.12.2-bookworm
-ARG SDF_VERSION=0.1.192
+ARG SDF_VERSION=0.2.12
 
 # Install dependencies
 RUN apt-get update && apt-get install -y \
-    yq \
     curl \
     && rm -rf /var/lib/apt/lists/*
 
 # Install sdf
-RUN curl -LSfs https://cdn.sdf.com/releases/download/install.sh | bash -s -- --version ${SDF_VERSION}
+RUN if [ "$(uname -m)" = "aarch64" ]; then \
+    curl -LSfs https://cdn.sdf.com/releases/download/install.sh | bash -s -- --version ${SDF_VERSION} --target aarch64-unknown-linux-gnu ; \
+    else \
+    curl -LSfs https://cdn.sdf.com/releases/download/install.sh | bash -s -- --version ${SDF_VERSION} ; \
+    fi
+# replace above with a pre-built image?
 
-# Install dbt-snowflake plugin using pip
-RUN python3.12 -m venv .venv && . .venv/bin/activate \
-    && python3 -m pip install dbt-snowflake==1.7.2 \
-    && python3 -m pip install --upgrade dbt-core==1.7.9 \
-    && python3 -m pip install protobuf==4.25.3
-
-# Copy your code file from your action repository to the filesystem path `/` of the container
 COPY entrypoint.sh /entrypoint.sh
 
 # Set the code file as the entry point

LICENSE

@@ -0,0 +1,13 @@
+Copyright [2024] [SDF Labs]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

README.md

@@ -1,2 +1,28 @@
 # sdf-action
-[WIP] A Github Action to run `sdf` CLI in workflows.
+Github Action to run `sdf` CLI in workflows.
+
+## Usage
+Check out this [example workflow](./.github/workflows/examples.yml) to see how to use this action.
+
+## Parameters
+
+* `snowflake_`* parameters are required if the `snowflake` table provider is used
+* `aws_*` parameters are required if the `redshift` table provider is used
+* `access_key` and `secret_key` are required if the `sdf push` is used in `command`
+
+| Parameter | Description | Required | Default |
+| --- | --- | --- | --- |
+| `command` | The `sdf` CLI command to run. | No | `sdf compile`
+| `workspace_dir` | The directory of the workspace  | No | `"."` |
+| `access_key` | access key created from the [console](https://console.sdf.com/catalog/settings/general) to be used in `sdf push`  | No | |
+| `secret_key` | secret key created from the [console](https://console.sdf.com/catalog/settings/general) to be used in `sdf push` | No | |
+| `is_dbt` | Set to a non-empty string if the workspace is dbt based | No | `""` | |
+| `dbt_target` | The dbt target | No | `"dev"` |
+| `snowflake_account_id` | The snowflake account | No | | 
+| `snowflake_username` | The snowflake username | No | |
+| `snowflake_password` | The snowflake password | No | |
+| `snowflake_role` | The snowflake role | No | |
+| `snowflake_warehouse` | The snowflake warehouse | No | |
+| `aws_region` | The aws region | No | |
+| `aws_access_key_id` | The aws access key id created from an IAM user | No | |
+| `aws_secret_access_key` | The aws secret created from an IAM user | No | |

action.yml

@@ -1,15 +1,15 @@
 # action.yml
-name: "dbt action"
+name: "sdf action"
 description: "Run sdf cli commands"
 inputs:
   command:
     description: "The sdf command to run"
     default: "sdf compile"
-    required: true
+    required: false
   workspace_dir:
     description: "The directory of the workspace"
     default: "."
-    required: true
+    required: false
   access_key:
     description: "The access key"
     required: false
@@ -18,11 +18,12 @@ inputs:
     required: false
   is_dbt:
     description: "Whether the workspace is dbt based or not"
-    required: true
+    required: false
     default: ""
   dbt_target:
     description: "The dbt target"
     required: false
+    default: "dev"
 
   # required if snowflake table provider is used
   snowflake_account_id:

entrypoint.sh

@@ -1,7 +1,5 @@
 #!/bin/bash -l
 
-source /.venv/bin/activate
-
 echo "workspace dir set as: \"${WORKSPACE_DIR}\""
 cd ${WORKSPACE_DIR}
 
@@ -20,7 +18,7 @@ check_exit_status() {
       echo "$command_log"
       echo EOF
     } >>$GITHUB_OUTPUT
-    
+
     echo "result=failed" >>$GITHUB_OUTPUT
     exit $exit_status
   fi
@@ -34,33 +32,12 @@ if [[ $input_command == "sdf push"* ]]; then
 fi
 
 if [[ -n $input_is_dbt ]]; then
-  echo "python3 version - $(python3 --version)"
-
   echo "::group::Setting up dbt"
-  echo "running dbt deps"
-  dbt deps
-  check_exit_status $? ""
-
-  echo "running dbt compile"
-  dbt compile
-  check_exit_status $? ""
-
-  echo "running dbt compile done"
   sdf dbt refresh
   echo "::endgroup::"
   check_exit_status $? ""
 fi
 
-# run sdf auth login snwoflake if necessary
-snowflake_provider=$(yq .provider.type workspace.sdf.yml | grep snowflake | tail -1)
-if [[ -n $snowflake_provider ]]; then
-  echo "snowflake provider used: running 'sdf auth login'"
-  sdf auth login snowflake \
-    --account-id "${SNOWFLAKE_ACCOUNT_ID}" --username "${SNOWFLAKE_USERNAME}" --password "${SNOWFLAKE_PASSWORD}" \
-    --role "${SNOWFLAKE_ROLE}" --warehouse "${SNOWFLAKE_WAREHOUSE}"
-  check_exit_status $? ""
-fi
-
 # run and save outputs
 echo "running command: $input_command"
 log=$($input_command 2>&1)
@@ -73,4 +50,4 @@ check_exit_status $exit_status "$log"
   echo "$log"
   echo EOF
 } >>$GITHUB_OUTPUT
-echo "result=passed" >>$GITHUB_OUTPUT
+echo "result=passed" >>$GITHUB_OUTPUT