Skip to content

Commit

Permalink
improved documentation about guacamole-ignore
Browse files Browse the repository at this point in the history
  • Loading branch information
tobias-theodo committed Dec 6, 2024
1 parent 98453b1 commit c05eefb
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,25 @@ Three modes currently exist :

A verbose mode (`-v`) exists to add more information to the output.

**Skipping individual checks**

You can use inline code comments to skip individual checks for a particular resource.

To skip a check on a given Terraform definition block resource, apply the following comment pattern inside its scope: `# guacamole-ignore:<check_id> <suppression_comment>`

<check_id> is one of the available check scanners.
<suppression_comment> is an optional suppression reason.

Example:

The following comment skips the `TF_NAM_001` check on the resource identified by `network`

```bash
# guacamole-ignore:TF_NAM_001 We will be creating more rg
resource "azurerm_resource_group" "network" {
name...
```
## List of checks
### Static module check for Terraform
Expand Down

0 comments on commit c05eefb

Please sign in to comment.