Skip to content

Commit

Permalink
chore(docs): Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
robcoward committed Jul 23, 2024
1 parent 675182f commit 8899e07
Showing 1 changed file with 14 additions and 10 deletions.
24 changes: 14 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,22 @@ Add the following snippet to the script section of your `bitbucket-pipelines.yml

```yaml
script:
- pipe: devopsconsultants/terraform-checks:0.1.0
- pipe: docker://quay.io/devops_consultants/terraform-checks:latest
variables:
NAME: "<string>"
TF_MODULE_PATH: "<string>"
# DEBUG: "<boolean>" # Optional
```

## Variables

| Variable | Usage |
| --------- | -------------------------------------------------- |
| NAME (\*) | The name that will be printed in the logs |
| DEBUG | Turn on extra debug information. Default: `false`. |
| Variable | Usage |
| ------------------- | -------------------------------------------------- |
| TF_MODULE_PATH (\*) | The path to the module |
| DEBUG | Turn on extra debug information. Default: `false`. |
| RUN_FMT | Run Terraform Format. Default: `true`. |
| RUN_VALIDATE | Run Terraform Validate. Default: `true`. |
| RUN_TFLINT | Run tflint. Default: `true` |
| RUN_TRIVY | Run trivy. Default: `true` |

_(\*) = required variable._

Expand All @@ -31,17 +35,17 @@ Basic example:

```yaml
script:
- pipe: devopsconsultants/terraform-checks:0.1.0
- pipe: docker://quay.io/devops_consultants/terraform-checks:latest
variables:
NAME: "foobar"
TF_MODULE_PATH: "modules/foobar"
```
Advanced example:
```yaml
script:
- pipe: devopsconsultants/terraform-checks:0.1.0
- pipe: docker://quay.io/devops_consultants/terraform-checks:latest
variables:
NAME: "foobar"
TF_MODULE_PATH: "modules/foobar"
DEBUG: "true"
```

0 comments on commit 8899e07

Please sign in to comment.