fix(terraform_docs): Fix issue with processing multiply files without terraform-docs markers. Issue introduced in v1.95.0 (antonbabenko#720)

ryan-at-ld · web-flow · commit 2b1aec86d8a0 · 2024-09-17T13:58:50.000+03:00
A bug in the terraform-docs hook was introduced by the code changes in antonbabenko#717. [A continue statement was added that is not preceded by a `popd` command](https://github.com/antonbabenko/pre-commit-terraform/blob/869a106a4c8c48f34f58318a830436142e31e10a/hooks/terraform_docs.sh#L216). The bug is only triggered when the hook is processing multiple files where one (or more) of the files does not contain the terraform-docs marker statements. The hook fails to process the remaining files because the working directory is not reset to the root of the repository.
diff --git a/hooks/terraform_docs.sh b/hooks/terraform_docs.sh
@@ -213,7 +213,7 @@ function terraform_docs {
     #
     if [[ $add_to_existing == false ]]; then
       have_marker=$(grep -o "$insertion_marker_begin" "$output_file") || unset have_marker
-      [[ ! $have_marker ]] && continue
+      [[ ! $have_marker ]] && popd > /dev/null && continue
     fi
     # shellcheck disable=SC2086
     terraform-docs --output-mode="$output_mode" --output-file="$output_file" $tf_docs_formatter $args ./ > /dev/null

Original file line number	Diff line number	Diff line change
`@@ -213,7 +213,7 @@ function terraform_docs {`
`213`	`213`	`#`
`214`	`214`	`if [[ $add_to_existing == false ]]; then`
`215`	`215`	`have_marker=$(grep -o "$insertion_marker_begin" "$output_file") \|\| unset have_marker`
`216`		`- [[ ! $have_marker ]] && continue`
	`216`	`+ [[ ! $have_marker ]] && popd > /dev/null && continue`
`217`	`217`	`fi`
`218`	`218`	`# shellcheck disable=SC2086`
`219`	`219`	`terraform-docs --output-mode="$output_mode" --output-file="$output_file" $tf_docs_formatter $args ./ > /dev/null`