Skip to content

Commit 0ae533e

Browse files
fix: update readme.md with terraform checks
1 parent 7b0bb3c commit 0ae533e

File tree

2 files changed

+64
-0
lines changed

2 files changed

+64
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,10 @@ Above example is just a simple example to call workflow from github shared workf
5454
* [Example for scan and push docker image on Dockerhub](https://github.com/clouddrove/github-shared-workflows/blob/master/docs/docker.md#example-for-scan-and-push-docker-image-on-dockerhub)
5555
* [Example for scan and push docker image on ECR](https://github.com/clouddrove/github-shared-workflows/blob/master/docs/docker.md#example-for-scan-and-push-docker-image-on-ecr)
5656
4. [Auto Assign Assignee Workflow](https://github.com/clouddrove/github-shared-workflows/blob/master/docs/auto-assignee.md)
57+
5. [Terraform Checks Workflow](https://github.com/clouddrove/github-shared-workflows/blob/master/docs/terraform-checks.md)
58+
* [Example for terraform checks with azure cloud](https://github.com/clouddrove/github-shared-workflows/blob/master/docs/terraform-checks.md#example-for-terraform-checks-with-azure-cloud)
59+
* [Example for terraform checks with aws cloud](https://github.com/clouddrove/github-shared-workflows/blob/master/docs/terraform-checks.md#example-for-terraform-checks-with-aws-cloud)
60+
* [Example for terraform checks with digitalocean cloud](https://github.com/clouddrove/github-shared-workflows/blob/master/docs/terraform-checks.md#example-for-terraform-checks-with-digitalocean-cloud)
5761
5862
## Feedback
5963
If you come accross a bug or have any feedback, please log it in our [issue tracker](https://github.com/clouddrove/github-shared-workflows/issues), or feel free to drop us an email at [[email protected]](mailto:[email protected]).

docs/terraform-checks.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
## [Terraform Checks Workflow](https://github.com/clouddrove/github-shared-workflows/blob/master/.github/workflows/terraform.yml)
2+
3+
This workflow is used to terraform checks. Workflows have been added in `.github/workflows/terraform.yml`
4+
5+
#### Usage
6+
This workflow is used to terraform checks. Workflows have been added in `.github/workflows/terraform.yml`
7+
8+
#### Example with azure cloud
9+
```yaml
10+
name: Terraform Checks
11+
12+
on:
13+
pull_request:
14+
15+
jobs:
16+
terraform:
17+
uses: clouddrove/github-shared-workflows/.github/workflows/terraform.yml@master
18+
secrets:
19+
GITHUB: ${{ secrets.GITHUB }}
20+
DIGITALOCEAN_ACCESS_TOKEN: ${{ secrets.DIGITALOCEAN_ACCESS_TOKEN }}
21+
with:
22+
provider: 'azurerm'
23+
working_directory: './_example/'
24+
```
25+
#### Example with aws cloud
26+
```yaml
27+
name: Terraform Checks
28+
29+
on:
30+
pull_request:
31+
32+
jobs:
33+
terraform:
34+
uses: clouddrove/github-shared-workflows/.github/workflows/terraform.yml@master
35+
secrets:
36+
GITHUB: ${{ secrets.GITHUB }}
37+
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
38+
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
39+
AWS_SESSION_TOKEN: ${{ secrets.AWS_SESSION_TOKEN }}
40+
with:
41+
provider: 'aws'
42+
working_directory: './_example/'
43+
```
44+
#### Example with digitalocean cloud
45+
```yaml
46+
name: Terraform Checks
47+
48+
on:
49+
pull_request:
50+
51+
jobs:
52+
terraform:
53+
uses: clouddrove/github-shared-workflows/.github/workflows/terraform.yml@master
54+
secrets:
55+
GITHUB: ${{ secrets.GITHUB }}
56+
DIGITALOCEAN_ACCESS_TOKEN: ${{ secrets.DIGITALOCEAN_ACCESS_TOKEN }}
57+
with:
58+
provider: 'digitalocean'
59+
working_directory: './_example/'
60+
```

0 commit comments

Comments
 (0)