Skip to content

Commit 56d6a1f

Browse files
Update README.md
1 parent 312cc5e commit 56d6a1f

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,22 @@ Github Action as a wrapper for executing a single command in stackql, maps all s
33

44
# Usage
55

6+
## AUTH
7+
8+
`Example auth string`
9+
```
10+
{ "google": { "type": "service_account", "credentialsfilepath": "sa-key.json" },
11+
"github": { "type": "basic", "credentialsenvvar": "STACKQL_GITHUB_CREDS" }}
12+
```
13+
It can be passed with `auth_str` as a string, or stored in a file and pass filename to `auth-obj-path`
14+
- For "basic" auth, you need to set a environment variable with same name as the value of `credentialsenvvar` in the auth string for the Github Action step. You can use [Github Secrets](https://docs.github.com/en/actions/reference/encrypted-secrets) to store the value of the environment variable, and use env to pass it to the action. For example:
15+
```
16+
env:
17+
STACKQL_GITHUB_CREDS: ${{ secrets.STACKQL_GITHUB_CREDS }}
18+
```
19+
- For "service_account" auth, you need to store the credentials into a file; You can follow the example of `Prep Google Creds (bash)` step in the example
20+
21+
# Examples
622
## Basic Example
723
```
824
- name: exec github example

0 commit comments

Comments
 (0)