Skip to content

Commit 5ebeed9

Browse files
improved the read me
1 parent 69348b9 commit 5ebeed9

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,25 @@ The `stackql/setup-stackql` action is a JavaScript action that sets up Terraform
66
- Setup AUTH env var in the Github Action
77

88
# Auth
9+
[Learn more](https://stackql.io/docs/getting-started/authenticating) about authentication setup when running stackql
10+
911
### Basic Example
10-
1. Set Auth variable:
12+
1. Set Auth variable, for example:
1113
```
1214
{ "github": { "type": "basic", "credentialsenvvar": "STACKQL_GITHUB_CREDS" } }
1315
```
1416
2. create the github token as a secret
1517
3. In the execution step, pass the secret as environment variable with name "STACKQL_GITHUB_CREDS"
1618

17-
Check the "Use GitHub Provider" step in `.github/workflows/example-workflows.yml`
19+
Check the "Use GitHub Provider" step in `.github/workflows/example-workflows.yml` for the working example
1820

1921
### json File Auth example
2022

21-
1. Set Auth variable:
23+
1. Set Auth variable, for example:
2224
```
2325
{ "google": { "type": "service_account", "credentialsfilepath": "sa-key.json" }}
2426
```
2527
2. encode the key json file into base64 string
2628
3. in execution step, run `sudo echo ${{ secrets.<name of the secret> }} | base64 -d > sa-key.json`
2729

28-
Check the "Use Google Provider" step in `.github/workflows/example-workflows.yml`
30+
Check the "Use Google Provider" step in `.github/workflows/example-workflows.yml` for the working example

0 commit comments

Comments
 (0)