Skip to content

terraform_docs starting from 1.94.0 ignores --hook-config=--add-to-existing-file=false (our default behavior) #715

@MaxymVlasov

Description

@MaxymVlasov

Describe the bug

terraform-docs --output-mode="inject" --output-file=README.md md .

which is exactly what we run by default

terraform-docs --output-mode="$output_mode" --output-file="$output_file" $tf_docs_formatter $args ./ > /dev/null

by

repos:
  - repo: https://github.com/antonbabenko/pre-commit-terraform
    rev: v1.94.2 # issue introduced in 1.94.0
    hooks:
      - id: terraform_docs

always updates/add terraform-docs section, as long as file exist.

This break your --add-to-existing-file setting, which by default set to false

How can we reproduce it?

testdir=$(mktemp -d)
cd $testdir
touch main.tf README.md
echo "
repos:
  - repo: https://github.com/antonbabenko/pre-commit-terraform
    rev: v1.94.2 # issue introduced in 1.94.0
    hooks:
      - id: terraform_docs
" > .pre-commit-config.yaml
git init
git add -A
pre-commit run

Workaround

  • if you on Linux (and you have no Mac users) - stick to v1.93.1
  • otherwise, stick to v1.92.3

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions