Merge pull request #7 from stackql/develop-v1

Merge develop-v1 to main

Author: yunchengyang515

.github/set-up-stackql.yml

@@ -0,0 +1,51 @@
+name: 'Setup StackQL'
+
+on:
+  push:
+    branches:
+    - main
+    - 'develop-**'
+  pull_request:
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  stackql-tests:
+    name: 'Stackql Examples'
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+
+    - name: Setup stackql
+      uses: ./
+      with:
+        use_wrapper: 'true'
+
+
+    - name: Validate Stackql Version
+      run: |
+        stackql --version
+
+    - name: Use GitHub Provider
+      run: |
+        stackql exec -i ./examples/github-example.iql --auth="${AUTH}"
+      env: 
+        AUTH: ${{ vars.AUTH }}  ##'{ "github": { "type": "basic", "credentialsenvvar": "STACKQL_GITHUB_CREDS" } }'
+        STACKQL_GITHUB_CREDS: ${{  secrets.STACKQL_GITHUB_CREDS }}
+
+    - name: Use Google Provider
+      run: | ## use the secret to create json file
+        sudo echo ${{ secrets.GOOGLE_CREDS }} | base64 -d > sa-key.json
+        stackql exec -i ./examples/google-example.iql --auth="${AUTH}"
+      env:
+        AUTH: ${{ vars.AUTH }}  ## '{ "google": { "type": "service_account",  "credentialsfilepath": "sa-key.json" }}'
+
+    ##### uncomment the step to see error handling
+    # - name: Handle error
+    #   run: | ## use the secret to create json file
+    #     stackql exec -i ./examples/github-example.iql --auth="${INVALID_AUTH}"
+

.github/workflows/example-workflows.yml

@@ -0,0 +1 @@
+node_modules

.gitignore

@@ -0,0 +1 @@
+_

.husky/.gitignore

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run build && git add dist/ && git add wrapper/

.husky/pre-commit

@@ -0,0 +1,30 @@
+# setup-stackql
+
+The `stackql/setup-stackql` action is a JavaScript action that sets up StackQL CLI in your GitHub Actions workflow by:
+
+- Downloading a latest Stackql CLI and adding it to the `PATH`.
+- Setup AUTH env var in the Github Action
+
+# Auth
+[Learn more](https://stackql.io/docs/getting-started/authenticating) about authentication setup when running stackql
+
+### Basic Example
+1. Set Auth variable, for example:
+```
+{ "github": { "type": "basic", "credentialsenvvar": "STACKQL_GITHUB_CREDS" } }
+```
+2. create the github token as a secret
+3. In the execution step, pass the secret as environment variable with name "STACKQL_GITHUB_CREDS"
+
+Check the "Use GitHub Provider" step in `.github/workflows/example-workflows.yml` for the working example
+
+### json File Auth example
+
+1. Set Auth variable, for example:
+```
+{ "google": { "type": "service_account",  "credentialsfilepath": "sa-key.json" }}
+```
+2. encode the key json file into base64 string
+3. in execution step, run `sudo echo ${{ secrets.<name of the secret> }} | base64 -d > sa-key.json`
+
+Check the "Use Google Provider" step in `.github/workflows/example-workflows.yml` for the working example

README.md

@@ -2,19 +2,14 @@ name: 'StackQL Studio - Setup StackQL'
 description: 'Sets up StackQL CLI in your GitHub Actions workflow.'
 author: 'Yuncheng Yang, StackQL'
 inputs:
-  platform:
-    description: 'Platform that function is running on'
-    required: true
-  # authentications_object_string:
-  #   description: 'The authentication object'
-  #   required: true
-  # stackql_wrapper:
-  #   description: 'Whether or not to install a wrapper to wrap subsequent calls of the `stackql` binary and expose its STDOUT, STDERR, and exit code as outputs named `stdout`, `stderr`, and `exitcode` respectively. Defaults to `true`.'
-  #   default: 'true'
-  #   required: false
+  use_wrapper:
+    description: 'Whether or not to install a wrapper to wrap subsequent calls of the `stackql` binary and expose its STDOUT, STDERR, and exit code as outputs named `stdout`, `stderr`, and `exitcode` respectively. Defaults to `true`.'
+    default: 'true'
+    required: false
+
 runs:
   using: 'node16'
-  main: 'index.js'
+  main: 'dist/index.js'
 branding:
   icon: 'terminal'
   color: 'purple'