Skip to content

Commit 7fe88c6

Browse files
jeffreyavenjeffreyaven
committed
updated docs
1 parent 3f51efa commit 7fe88c6

File tree

2 files changed

+22
-22
lines changed

2 files changed

+22
-22
lines changed

‎.github/workflows/stackql.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ jobs:
2222
fetch-depth: 0
2323

2424
- name: setup StackQL
25-
uses: stackql/setup-stackql@v2.0.0
25+
uses: stackql/setup-stackql@v2.2.3
2626
with:
2727
use_wrapper: true
2828

@@ -41,27 +41,27 @@ jobs:
4141
--output text -H --dryrun
4242
4343
- name: deploy instances using stackql-exec
44-
uses: stackql/stackql-exec@v1.3.1
44+
uses: stackql/stackql-exec@v2.2.3
4545
with:
4646
query_file_path: './stackql/scripts/deploy-instances/deploy-instances.iql'
4747
data_file_path: './stackql/data/vars.jsonnet'
4848
vars: GOOGLE_PROJECT=${{ env.GOOGLE_PROJECT }},GOOGLE_ZONE=${{ env.GOOGLE_ZONE }}
4949

5050
- name: check if we have 4 instances using stackql-assert
51-
uses: stackql/stackql-assert@v1.3.2
51+
uses: stackql/stackql-assert@v2.2.3
5252
with:
5353
test_query_file_path: './stackql/scripts/check-instances/check-instances.iql'
5454
data_file_path: './stackql/data/vars.jsonnet'
5555
vars: GOOGLE_PROJECT=${{ env.GOOGLE_PROJECT }},GOOGLE_ZONE=${{ env.GOOGLE_ZONE }}
5656
expected_rows: 4
5757

5858
- name: stop running instances using stackql-exec
59-
uses: stackql/stackql-exec@v1.3.1
59+
uses: stackql/stackql-exec@v2.2.3
6060
with:
6161
query_file_path: './stackql/scripts/stop-instances/stop-instances.iql'
6262

6363
- name: "[CLEANUP] delete instances using stackql-exec"
64-
uses: stackql/stackql-exec@v1.3.1
64+
uses: stackql/stackql-exec@v2.2.3
6565
with:
6666
query_file_path: './stackql/scripts/delete-instances/delete-instances.iql'
6767
data_file_path: './stackql/data/vars.jsonnet'
@@ -82,7 +82,7 @@ jobs:
8282
fetch-depth: 0
8383

8484
- name: setup StackQL
85-
uses: stackql/setup-stackql@v2.0.0
85+
uses: stackql/setup-stackql@v2.2.3
8686
with:
8787
use_wrapper: true
8888

@@ -116,19 +116,19 @@ jobs:
116116
run: cd terraform; terraform apply -no-color -var-file=stackql-demo.tfvars -auto-approve
117117

118118
- name: check terraform deployment using stackql-assert - should pass
119-
uses: stackql/stackql-assert@v1.3.2
119+
uses: stackql/stackql-assert@v2.2.3
120120
with:
121121
test_query_file_path: './stackql/scripts/check-terraform-instances/check-terraform-instances.iql'
122122
expected_rows: 3
123123

124124
- name: run a compliance check using stackql-assert - should fail
125-
uses: stackql/stackql-assert@v1.3.2
125+
uses: stackql/stackql-assert@v2.2.3
126126
with:
127127
test_query_file_path: './stackql/scripts/run-compliance-checks/run-compliance-checks.iql'
128128
expected_rows: 0
129129

130130
- name: "[CLEANUP] delete instances and bucket using stackql-exec"
131131
if: failure()
132-
uses: stackql/stackql-exec@v1.3.1
132+
uses: stackql/stackql-exec@v2.2.3
133133
with:
134134
query_file_path: './stackql/scripts/terraform-cleanup/terraform-cleanup.iql'

‎README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
>
44
> Check out the issues and get started with your first pull request!, Let’s build something amazing together this Hacktoberfest!
55
6-
💡 **Explore our repositories:** [StackQL](https://github.com/stackql/stackql), [__`stackql-exec`__](https://github.com/marketplace/actions/stackql-studios-stackql-exec), [__`stackql-assert`__](https://github.com/marketplace/actions/stackql-studios-stackql-assert), [StackQL Deploy](https://stackql-deploy.io/docs/), find provider documentation in the [StackQL Provider Registry Docs](https://registry.stackql.io/)
6+
💡 **Explore our repositories:** [StackQL](https://github.com/stackql/stackql), [__`stackql-exec`__](https://github.com/marketplace/actions/stackql-exec), [__`stackql-assert`__](https://github.com/marketplace/actions/stackql-assert), [StackQL Deploy](https://stackql-deploy.io/docs/), find provider documentation in the [StackQL Provider Registry Docs](https://registry.stackql.io/)
77

88
🔎 Build out example queries for [`aws`](https://aws.stackql.io/providers/aws/), [`gcp`](https://google.stackql.io/providers/google/), [`azure`](https://azure.stackql.io/providers/azure/), [`digitalocean`](https://digitalocean.stackql.io/providers/digitalocean/), [`linode`](https://linode.stackql.io/providers/linode/), [`okta`](https://okta.stackql.io/providers/okta/) and more, including multicloud queries!
99

@@ -14,9 +14,9 @@
1414
This repository demonstrates using [__StackQL__](https://github.com/stackql/stackql) with GitHub Actions. StackQL can provision, de-provision, and perform lifecycle operations on cloud resources across all major cloud providers.
1515

1616
StackQL GitHub Actions include:
17-
- [__`setup-stackql`__](https://github.com/marketplace/actions/stackql-studios-setup-stackql) : Installs the `stackql` cli on actions runners, used if you want to perform custom operations using StackQL
18-
- [__`stackql-exec`__](https://github.com/marketplace/actions/stackql-studios-stackql-exec) : Executes a StackQL query within an Actions workflow; this could be used to provision, de-provision, or perform lifecycle operations on cloud resources (using the [`INSERT`](https://stackql.io/docs/language-spec/insert), `UPDATE`, [`DELETE`](https://stackql.io/docs/language-spec/delete), [`EXEC`](https://stackql.io/docs/language-spec/exec) methods), as well as running queries and returning results to the log, file or variable (using the [`SELECT`](https://stackql.io/docs/language-spec/select) method)
19-
- [__`stackql-assert`__](https://github.com/marketplace/actions/stackql-studios-stackql-assert) : Used to test assertions against the results of a StackQL query, this can be used to validate the state of a resource after an IaC or lifecycle operation has been performed, or to validate the system (e.g., CSPM or compliance queries)
17+
- [__`setup-stackql`__](https://github.com/marketplace/actions/setup-stackql) : Installs the `stackql` cli on actions runners, used if you want to perform custom operations using StackQL
18+
- [__`stackql-exec`__](https://github.com/marketplace/actions/stackql-exec) : Executes a StackQL query within an Actions workflow; this could be used to provision, de-provision, or perform lifecycle operations on cloud resources (using the [`INSERT`](https://stackql.io/docs/language-spec/insert), `UPDATE`, [`DELETE`](https://stackql.io/docs/language-spec/delete), [`EXEC`](https://stackql.io/docs/language-spec/exec) methods), as well as running queries and returning results to the log, file or variable (using the [`SELECT`](https://stackql.io/docs/language-spec/select) method)
19+
- [__`stackql-assert`__](https://github.com/marketplace/actions/stackql-assert) : Used to test assertions against the results of a StackQL query, this can be used to validate the state of a resource after an IaC or lifecycle operation has been performed, or to validate the system (e.g., CSPM or compliance queries)
2020

2121
## Prerequisites
2222

@@ -43,11 +43,11 @@ Workflow fragments are explained here:
4343

4444
### setup StackQL
4545

46-
This step uses the [__`setup-stackql`__](https://github.com/marketplace/actions/stackql-studios-setup-stackql) action to install the `stackql` cli on the actions runner, which is then available to all subsequent steps in the job via `stackql`.
46+
This step uses the [__`setup-stackql`__](https://github.com/marketplace/actions/setup-stackql) action to install the `stackql` cli on the actions runner, which is then available to all subsequent steps in the job via `stackql`.
4747

4848
```yaml
4949
- name: setup StackQL
50-
uses: stackql/setup-stackql@v2.0.0
50+
uses: stackql/setup-stackql@v2.2.3
5151
with:
5252
use_wrapper: true
5353
```
@@ -72,11 +72,11 @@ This step demonstrates how to use the `stackql` cli (after the previous `setup-s
7272
```
7373
### deploy instances using `stackql-exec`
7474

75-
This step demonstrates how to use the [__`stackql-exec`__](https://github.com/marketplace/actions/stackql-studios-stackql-exec) method to perform a StackQL query; in this case, we are using the `INSERT` method to deploy instances on GCP.
75+
This step demonstrates how to use the [__`stackql-exec`__](https://github.com/marketplace/actions/stackql-exec) method to perform a StackQL query; in this case, we are using the `INSERT` method to deploy instances on GCP.
7676

7777
```yaml
7878
- name: deploy instances using stackql-exec
79-
uses: stackql/stackql-exec@v1.3.1
79+
uses: stackql/stackql-exec@v2.2.3
8080
with:
8181
query_file_path: './stackql/scripts/deploy-instances/deploy-instances.iql'
8282
data_file_path: './stackql/data/vars.jsonnet'
@@ -93,7 +93,7 @@ This step demonstrates how to use `stackql` via the `stackql-exec` action to per
9393

9494
```yaml
9595
- name: stop running instances using stackql-exec
96-
uses: stackql/stackql-exec@v1.3.1
96+
uses: stackql/stackql-exec@v2.2.3
9797
with:
9898
query_file_path: './stackql/scripts/stop-instances/stop-instances.iql'
9999
data_file_path: './stackql/data/vars.jsonnet'
@@ -106,11 +106,11 @@ This step demonstrates how to use `stackql` via the `stackql-exec` action to per
106106

107107
### check if we have 4 instances using `stackql-assert`
108108

109-
This step demonstrates how to use the [__`stackql-assert`__](https://github.com/marketplace/actions/stackql-studios-stackql-assert) action to run a StackQL `SELECT` query and compare the actual result count with an expected result count, if there is a discrepancy then the action will fail.
109+
This step demonstrates how to use the [__`stackql-assert`__](https://github.com/marketplace/actions/stackql-assert) action to run a StackQL `SELECT` query and compare the actual result count with an expected result count, if there is a discrepancy then the action will fail.
110110

111111
```yaml
112112
- name: check if we have 4 instances using stackql-assert
113-
uses: stackql/stackql-assert@v1.3.1
113+
uses: stackql/stackql-assert@v2.2.3
114114
with:
115115
test_query_file_path: './stackql/scripts/check-instances.iql'
116116
data_file_path: './stackql/data/vars.jsonnet'
@@ -128,7 +128,7 @@ This step demonstrates how to use the `stackql-assert` action in a `terraform` d
128128

129129
```yaml
130130
- name: check terraform deployment using stackql-assert
131-
uses: stackql/stackql-assert@v1.3.1
131+
uses: stackql/stackql-assert@v2.2.3
132132
with:
133133
test_query_file_path: './stackql/scripts/check-terraform-instances/check-terraform-instances.iql'
134134
expected_results_str: '[{"name":"terraform-test-1","name":"terraform-test-2"}]'
@@ -142,7 +142,7 @@ This step demonstrates how to use the `stackql-assert` action to run a complianc
142142

143143
```yaml
144144
- name: run a compliance check using stackql-assert
145-
uses: stackql/stackql-assert@v1.3.1
145+
uses: stackql/stackql-assert@v2.2.3
146146
with:
147147
test_query: |
148148
SELECT name

0 commit comments

Comments
 (0)