Closed mcinquin closed 8 months ago
Would the item 3 from https://github.com/antonbabenko/pre-commit-terraform#terraform_docs be sufficient in your use case (adding the --hook-config=--path-to-file=../README.md
to args
)?
You also most probably do not need --args=blueprint/
arg.
Hello,
Thank you for your quick response. I made the changes, but terraform_docs doesn't modify the README file in the right place
.pre-commit-config.yaml
:$ git status
On branch pre-commit
Changes not staged for commit:
(use "git add <file>..." to update what will be committed)
(use "git restore <file>..." to discard changes in working directory)
modified: blueprint/terraform.tf
no changes added to commit (use "git add" and/or "git commit -a")
$ pre-commit run -a -v
trim trailing whitespace.................................................Passed
- hook id: trailing-whitespace
- duration: 0.07s
fix end of files.........................................................Passed
- hook id: end-of-file-fixer
- duration: 0.06s
Terraform fmt............................................................Passed
- hook id: terraform_fmt
- duration: 0.21s
Terraform validate with tflint...........................................Passed
- hook id: terraform_tflint
- duration: 0.21s
Command 'tflint --init' successfully done:
Terraform validate with trivy............................................Passed
- hook id: terraform_trivy
- duration: 2.76s
2024-01-18T10:28:37.901+0100 INFO Misconfiguration scanning is enabled
2024-01-18T10:28:38.728+0100 INFO Detected config files: 1
2024-01-18T10:28:39.622+0100 INFO Misconfiguration scanning is enabled
2024-01-18T10:28:39.672+0100 INFO Detected config files: 0
Terraform docs...........................................................Passed
- hook id: terraform_docs
- duration: 0.37s
$ git status
On branch pre-commit
Changes not staged for commit:
(use "git add <file>..." to update what will be committed)
(use "git restore <file>..." to discard changes in working directory)
modified: blueprint/terraform.tf
Untracked files:
(use "git add <file>..." to include in what will be committed)
blueprint/README.md
no changes added to commit (use "git add" and/or "git commit -a")
That's odd 😿 Unfortunately I'm not user of tfdocs hooks. Maybe @MaxymVlasov can give a hint 🤔
ps: taking a wild guess — what if you remove file: README.md
from tfdocs config (so that we're sure there's no race condition)?
Thanks for pointing me in the right direction!
If I delete file: README.md
in the tfdocs configuration file, it doesn't work. However, if I put file: ../README.md
it works!
Thanks a lot for your reactivity!
Describe the bug
I have a tree structure where my tf files are not in the root but in a subfolder.
I want to be able to do as the following cli command
How can we reproduce it?
with terraform-doc cli
with pre-commit
Environment information
OS: Ubuntu 20.04
uname -a
and/orsysteminfo | Select-String "^OS"
output:Tools availability and versions:
.pre-commit-config.yaml
:file content
```yaml default_stages: [commit] repos: - repo: https://github.com/pre-commit/pre-commit-hooks rev: v4.5.0 hooks: - id: trailing-whitespace - id: end-of-file-fixer - repo: https://github.com/antonbabenko/pre-commit-terraform rev: v1.86.0 hooks: - id: terraform_fmt - id: terraform_tflint - id: terraform_trivy - id: terraform_docs args: - --args=--config=.terraform-docs.yml - --args=blueprint/ ```.terraform-docs.yml
:file content
```yaml formatter: markdown table sections: hide-all: true content: |- {{ .Requirements }} {{ .Providers }} {{ .Modules }} {{ .Inputs }} {{ .Outputs }} output: file: README.md mode: inject template: |- {{ .Content }} output-values: enabled: false from: "outputs.tf" sort: enabled: true by: "required" settings: anchor: true color: true default: true description: true escape: true hide-empty: false html: true indent: 3 lockfile: true read-comments: true required: true sensitive: true type: true ```