Describe the bug I have a tree structure where my tf files are not

Would the item 3 from <a href="https://github.com/antonbabenko/pre-commit-terraform#te

That's odd 😿 Unfortunately I'm not user of tfdocs hooks. Maybe <a class="user-mention

[terraform_docs] Can't define specific path about pre-commit-terraform HOT 4 CLOSED

mcinquin commented on June 2, 2024

[terraform_docs] Can't define specific path

from pre-commit-terraform.

Comments (4)

mcinquin commented on June 2, 2024 2

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!

.pre-commit-config.yaml

file content

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:
              - --hook-config=--path-to-file=../README.md
              - --args=--config=.terraform-docs.yml

.terraform-docs.yml

file content

formatter: markdown table

sections:
  hide-all: true

content: |-
  {{ .Requirements }}

  {{ .Providers }}

  {{ .Modules }}

  {{ .Inputs }}

  {{ .Outputs }}

output:
  file: ../README.md
  mode: inject
  template: |-
    <!-- BEGIN_AUTOMATED_TF_DOCS_BLOCK -->

    {{ .Content }}

    <!-- END_AUTOMATED_TF_DOCS_BLOCK -->

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

from pre-commit-terraform.

yermulnik commented on June 2, 2024

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.

from pre-commit-terraform.

mcinquin commented on June 2, 2024

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:

file content

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:
              - --hook-config=--path-to-file=../README.md
              - --args=--config=.terraform-docs.yml

$ 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")

from pre-commit-terraform.

yermulnik commented on June 2, 2024

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)?

from pre-commit-terraform.

[terraform_docs] Can't define specific path about pre-commit-terraform HOT 4 CLOSED

Comments (4)

Related Issues (20)

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent