Skip to content

Commit

Permalink
darwin updates
Browse files Browse the repository at this point in the history
  • Loading branch information
jeffreyaven committed Apr 28, 2024
1 parent ce6583a commit 792df74
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Authentication to StackQL providers is done via environment variables source fro
The following example demonstrate the use of the `stackql/setup-stackql` action in a GitHub Actions workflow, demonstrating how to use the action to install the `stackql` CLI and then use it to execute a StackQL query.

### GitHub Example
Check the "Use GitHub Provider" step in [setup-stackql.yml](.github/workflows/setup-stackql.yml) for the working example, for more information on the GitHub provider for StackQL, see the [GitHub Provider Docs](https://registry.stackql.io/github).
Check the "Use GitHub Provider" step in [setup-stackql-test.yml](.github/workflows/setup-stackql-test.yml) for the working example, for more information on the GitHub provider for StackQL, see the [GitHub Provider Docs](https://registry.stackql.io/github).

```yaml
- name: setup StackQL
Expand All @@ -30,7 +30,7 @@ Check the "Use GitHub Provider" step in [setup-stackql.yml](.github/workflows/se
```
### Google Example
Check the "Use Google Provider" step in [setup-stackql.yml](.github/workflows/setup-stackql.yml) for the working example, for more information on the Google provider for StackQL, see the [Google Provider Docs](https://registry.stackql.io/google).
Check the "Use Google Provider" step in [setup-stackql-test.yml](.github/workflows/setup-stackql-test.yml) for the working example, for more information on the Google provider for StackQL, see the [Google Provider Docs](https://registry.stackql.io/google).
```yaml
- name: setup StackQL
Expand All @@ -46,14 +46,14 @@ Check the "Use Google Provider" step in [setup-stackql.yml](.github/workflows/se
```
## Inputs
- `use_wrapper` - (optional) Whether to install a wrapper to wrap subsequent calls of
- __`use_wrapper`__ - (optional) Whether 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 `false`.

## Outputs
This action does not configure any outputs directly. However, when you set the `use_wrapper` input
to `true`, the following outputs are available for subsequent steps that call the `stackql` binary:

- `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.
- __`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.

0 comments on commit 792df74

Please sign in to comment.