Skip to content

Commit

Permalink
Merge pull request #34 from mineiros-io/mariux/terramate
Browse files Browse the repository at this point in the history
chore: update README
  • Loading branch information
mariux authored Apr 17, 2022
2 parents 86aafec + 02f9a29 commit db77269
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,13 @@ Currently, the following hooks are supported:
Terradoc configuration `*tfdoc.hcl` files to a canonical format and style.
- terradoc-validate: The terradoc fmt command is used validate
Terradoc configuration `*tfdoc.hcl` files.
- terradoc-generate: The terradoc generates a documentation file from
- terradoc-generate: The terradoc generate command generates a documentation file from
Terradoc configuration `*tfdoc.hcl` files

### Terramate

- terramate-generate: The terramate generate command generates code from Terramate configuration files

## Installation & Dependencies

1. Install [pre-commit](https://pre-commit.com/). E.g. `brew install pre-commit`
Expand Down Expand Up @@ -118,15 +122,16 @@ repos:
- id: markdown-link-check
args: [-p] # When adding the -p flag, markdown-link-check will always with an exit code 0, even if dead links are found
- id: shellcheck
- id: terradoc-validate
- id: terradoc-fmt
- id: terradoc-generate
- id: terramate-generate

# The following hooks are redundant when golangci-lint is being. Our recommendation is to use golangci-lint
# as the main linter for go since it enables you to run all available linters in parallel.
# For details please see the example configuration https://github.com/mineiros-io/pre-commit-hooks/blob/master/.golangci.example.yml
# - id: gofmt
# - id: goimports

```

Once you created the configuration file inside your repository, you must run `pre-commit install` to activate the hooks.
Expand Down

0 comments on commit db77269

Please sign in to comment.