Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Clarified how to use tfsec #19

Merged
merged 2 commits into from
Dec 8, 2022
Merged

docs: Clarified how to use tfsec #19

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
50c93f2
docs: Clarified how to use tfsec
baolsen Dec 8, 2022
c697a33
Update README.md
bryantbiggs Dec 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,19 @@ jobs:

The `clowdhaus/terraform-composite-actions/pre-commit` action will install the following tools which are intended to support the pre-commit hooks used within Terraform modules:

- [terraform](https:/hashicorp/terraform) using provided `terraform-version` input
#### Default

- [pre-commit](https:/pre-commit/pre-commit)
- [tflint](https:/terraform-linters/tflint)
- [terraform-docs](https:/terraform-docs/terraform-docs) using provided `terraform-docs-version` input
- [terraform](https:/hashicorp/terraform) using provided `terraform-version` input (required)
- [tflint](https:/terraform-linters/tflint) using provided `tflint-version` input (default = `latest`)
- [terraform-docs](https:/terraform-docs/terraform-docs) using provided `terraform-docs-version` input (default = `v0.16.0`)

#### Optional

- [tfsec](https://aquasecurity.github.io/tfsec), when `install-tfsec=true` (default = `false`), using provided `tfsec-version` input (default = `1.28.0`)
- [hcledit](https:/minamijoyo/hcledit) when `install-hcledit=true` (default = `false`), using provided `hcledit-version` input (default = `0.2.3`)

#### Example

```yml
jobs:
Expand All @@ -72,8 +81,10 @@ jobs:
- name: Sign AWS Lambda artifact
uses: clowdhaus/terraform-composite-actions/pre-commit@main
with:
# Configure default software
terraform-version: 1.2.0
terraform-docs-version: v16.0.0
terraform-docs-version: v0.16.0
# Configure optional software
install-hcledit: true
hcledit-version: 0.2.3
args: "--all-files --color always --show-diff-on-failure"
Expand Down