Skip to content

Commit

Permalink
docs(tg): example
Browse files Browse the repository at this point in the history
  • Loading branch information
Laudenlaruto committed Dec 19, 2024
1 parent 4862633 commit c100e71
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ The following [reusable workflows](https://docs.github.com/en/actions/using-work
To use these workflows in your project, copy files from the folders listed below, and paste them in the `.github/workflows/` folder in your own repo.

- [`global`](global/): for all your projects
- [`terraform`](terraform/): useful for Terraform modules and starters
- [`terraform`](terraform/): useful for Terraform modules
- [`terragrunt`](terragrunt/) : Use for Terragrunt project and terraform modules

Your repo should have the following structure:

Expand All @@ -40,6 +41,14 @@ Your repo should have the following structure:

## Workflow Designs

### `terragrunt-quality` workflow

- [`tenv`](https://github.com/tofuutils/tenv)make sure that the correct version of Terraform and terragrunt is used
- [`terraform fmt`](https://www.terraform.io/docs/cli/commands/fmt.html) to check the basic formatting of Terraform code
- [`terragrunt hclfmt`](https://terragrunt.gruntwork.io/docs/reference/cli-options/#hclfmt) to check the formatting of terragrunt hcl files
- [`guacamole`](https://github.com/padok-team/guacamole) check the code quality
- [`checkov`](https://www.checkov.io/) to check for security issues

### `terraform-quality` workflow

There are several tools to ensure that Terraform code is secure and follows best practices. We selected the following ones:
Expand Down
10 changes: 10 additions & 0 deletions terragrunt/terragrunt-quality.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
on:
pull_request:
branches:
- main
name: iac-quality
jobs:
terragrunt-quality:
uses: padok-team/github-workflows/.github/workflows/terragrunt-quality.yml@main
with:
workdir: starters/terraform

0 comments on commit c100e71

Please sign in to comment.