Merge pull request #8 from stackql/feat/set-action-output

- fix the output using composite action outputs
- added a validation step

Author: yunchengyang515

.github/workflows/stackql-exec.yml

@@ -34,14 +34,14 @@ jobs:
         sudo echo ${{ secrets.GOOGLE_CREDS }} | base64 -d > sa-key.json
 
     - name: exec google example with query file
-      id: exec-stackql-file
+      id: stackql-exec-file
       uses: ./
       with:
         auth_obj_path: './stackql_scripts/auth.json'
         query_file_path: './stackql_scripts/google-example.iql'
 
     - name: exec github example with query string
-      id: exec-stackql-string
+      id: stackql-exec-string
       uses: ./
       with:
         auth_str: '{ "github": { "type": "basic", "credentialsenvvar": "STACKQL_GITHUB_CREDS" } }'
@@ -53,4 +53,16 @@ jobs:
       env: 
         STACKQL_GITHUB_CREDS: ${{ secrets.STACKQL_GITHUB_CREDS }}
 
+    - name: validate stackql-exec output
+      shell: bash
+      run: |
+        if [ -z '${{ steps.stackql-exec-file.outputs.exec-result }}' ]; then
+          echo "exec-stackql output does not contain expected result"
+          exit 1
+        fi
+        if [ -z '${{ steps.stackql-exec-string.outputs.exec-result }}' ]; then
+          echo "exec-stackql output does not contain expected result"
+          exit 1
+        fi
+
 

README.md

@@ -86,8 +86,7 @@ where org = 'stackql';
 
 ## Outputs
 This action uses [setup-stackql](https://github.com/marketplace/actions/stackql-studio-setup-stackql), with use_wrapper set
-to `true`, the following outputs are available for subsequent steps that call the `stackql` binary:
+to `true`, `stdout` and `stderr` are set to `exec-result` and `exec-error`
 
-- `stdout` - The STDOUT stream of the call to the `stackql` binary.
-- `stderr` - The STDERR stream of the call to the `stackql` binary.
-- `exitcode` - The exit code of the call to the `stackql` binary.
+- `exec-result` - The STDOUT stream of the call to the `stackql` binary.
+- `exec-error` - The STDERR stream of the call to the `stackql` binary.

action.yml

@@ -18,6 +18,13 @@ inputs:
     description: output format
     default: 'json'
     required: false
+outputs:
+  exec-result:
+    description: "stdout of stackql command"
+    value: ${{ steps.exec-stackql.outputs.stdout }}
+  exec-error:
+    description: "stderr of stackql command"
+    value: ${{ steps.exec-stackql.outputs.stderr }}
 
 runs:
   using: "composite"
@@ -70,16 +77,6 @@ runs:
       shell: bash
       run: |
         ${{ env.STACKQL_COMMAND }}
-
-    - name: validate exec-stackql output
-      shell: bash
-      run: |
-        echo "exec-stackql output: ${{ steps.exec-stackql.outputs.stdout }}"
-        if [ -z ${{ steps.exec-stackql.outputs.stdout }} ]; then
-          echo "exec-stackql output does not contain expected result"
-          exit 1
-        fi
-
       
 branding:
   icon: 'terminal'

lib/tests/utils.test.js

@@ -1,4 +1,4 @@
-const { setupAuth, getStackqlCommand } = require("../utils");
+const { setupAuth, getStackqlCommand, setOutput } = require("../utils");
 
 describe("util", () => {
   let core;