Merge branch 'master' into renovate/gitleaks-gitleaks-8.x

Author: MaxymVlasov

.github/workflows/ci-cd.yml

@@ -110,7 +110,7 @@ jobs:
     steps:
     - name: Switch to using Python 3.13 by default
       # yamllint disable-line rule:line-length
-      uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b  # v5.3.0
+      uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38  # v5.4.0
       with:
         python-version: 3.13
     - name: Check out src from Git
@@ -275,7 +275,7 @@ jobs:
     steps:
     - name: Switch to using Python 3.13
       # yamllint disable-line rule:line-length
-      uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b  # v5.3.0
+      uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38  # v5.4.0
       with:
         python-version: 3.13
 

.github/workflows/codeql.yml

@@ -48,7 +48,7 @@ jobs:
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
       # yamllint disable-line rule:line-length
-      uses: github/codeql-action/init@f6091c0113d1dcf9b98e269ee48e8a7e51b7bdd4  # v3.28.5
+      uses: github/codeql-action/init@dd746615b3b9d728a6a37ca2045b68ca76d4841a  # v3.28.8
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in
@@ -61,7 +61,7 @@ jobs:
     # manually (see below)
     - name: Autobuild
       # yamllint disable-line rule:line-length
-      uses: github/codeql-action/autobuild@f6091c0113d1dcf9b98e269ee48e8a7e51b7bdd4  # v3.28.5
+      uses: github/codeql-action/autobuild@dd746615b3b9d728a6a37ca2045b68ca76d4841a  # v3.28.8
 
     # ℹ️ Command-line programs to run using the OS shell.
     # yamllint disable-line rule:line-length
@@ -77,6 +77,6 @@ jobs:
 
     - name: Perform CodeQL Analysis
       # yamllint disable-line rule:line-length
-      uses: github/codeql-action/analyze@f6091c0113d1dcf9b98e269ee48e8a7e51b7bdd4  # v3.28.5
+      uses: github/codeql-action/analyze@dd746615b3b9d728a6a37ca2045b68ca76d4841a  # v3.28.8
       with:
         category: /language:${{matrix.language}}

.github/workflows/pre-commit.yaml

@@ -56,7 +56,7 @@ jobs:
         ref: ${{ github.event.pull_request.head.sha }}
     # Skip terraform_tflint which interferes to commit pre-commit auto-fixes
     # yamllint disable-line rule:line-length
-    - uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b  # v5.3.0
+    - uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38  # v5.4.0
       with:
         python-version: '3.9'
     - name: Execute pre-commit

.github/workflows/reusable-tox.yml

@@ -159,7 +159,7 @@ jobs:
         by default
       id: python-install
       # yamllint disable-line rule:line-length
-      uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b  # v5.3.0
+      uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38  # v5.4.0
       with:
         python-version: ${{ inputs.python-version }}
 

.github/workflows/scorecards.yml

@@ -79,6 +79,6 @@ jobs:
     # Upload the results to GitHub's code scanning dashboard.
     - name: Upload to code-scanning
       # yamllint disable-line rule:line-length
-      uses: github/codeql-action/upload-sarif@f6091c0113d1dcf9b98e269ee48e8a7e51b7bdd4  # v3.28.5
+      uses: github/codeql-action/upload-sarif@dd746615b3b9d728a6a37ca2045b68ca76d4841a  # v3.28.8
       with:
         sarif_file: results.sarif

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.97.3](https://github.com/antonbabenko/pre-commit-terraform/compare/v1.97.2...v1.97.3) (2025-02-04)
+
+
+### Bug Fixes
+
+* **`terraform_docs`:** Fix bug introduced in `v1.97.2` ([#801](https://github.com/antonbabenko/pre-commit-terraform/issues/801)) ([64b81f4](https://github.com/antonbabenko/pre-commit-terraform/commit/64b81f449344ed72d180d57ce0a801389c018584)), closes [#796](https://github.com/antonbabenko/pre-commit-terraform/issues/796)
+
 ## [1.97.2](https://github.com/antonbabenko/pre-commit-terraform/compare/v1.97.1...v1.97.2) (2025-02-03)
 
 

hooks/_common.sh

@@ -52,7 +52,9 @@ function common::initialize {
 function common::parse_cmdline {
   # common global arrays.
   # Populated via `common::parse_cmdline` and can be used inside hooks' functions
-  ARGS=() HOOK_CONFIG=() FILES=()
+  ARGS=()
+  HOOK_CONFIG=()
+  FILES=()
   # Used inside `common::terraform_init` function
   TF_INIT_ARGS=()
   # Used inside `common::export_provided_env_vars` function

hooks/terraform_docs.sh

@@ -160,7 +160,7 @@ function terraform_docs {
     # `--hook-config=--path-to-file=` if it set
     local config_output_file
     # Get latest non-commented `output.file` from `.terraform-docs.yml`
-    config_output_file=$(grep -A1000 -e '^output:$' "$config_file" | grep -E '^[[:space:]]+file:' | tail -n 1) || true
+    config_output_file=$(grep -A1000 -e '^output:$' "$config_file" 2> /dev/null | grep -E '^[[:space:]]+file:' | tail -n 1) || true
 
     if [[ $config_output_file ]]; then
       # Extract filename from `output.file` line
@@ -176,7 +176,7 @@ function terraform_docs {
 
     # Use `.terraform-docs.yml` `output.mode` if it set
     local config_output_mode
-    config_output_mode=$(grep -A1000 -e '^output:$' "$config_file" | grep -E '^[[:space:]]+mode:' | tail -n 1) || true
+    config_output_mode=$(grep -A1000 -e '^output:$' "$config_file" 2> /dev/null | grep -E '^[[:space:]]+mode:' | tail -n 1) || true
     if [[ $config_output_mode ]]; then
       # Extract mode from `output.mode` line
       output_mode=$(echo "$config_output_mode" | awk -F':' '{print $2}' | tr -d '[:space:]"' | tr -d "'")
@@ -240,10 +240,21 @@ function terraform_docs {
       have_marker=$(grep -o "$insertion_marker_begin" "$output_file") || unset have_marker
       [[ ! $have_marker ]] && popd > /dev/null && continue
     fi
-    local config_options
-    [[ $have_config_flag == true ]] && config_options="--config=$config_file"
-    # shellcheck disable=SC2086
-    terraform-docs --output-mode="$output_mode" --output-file="$output_file" $tf_docs_formatter "$config_options" $args ./ > /dev/null
+
+    # shellcheck disable=SC2206
+    # Need to pass $tf_docs_formatter and $args as separate arguments, not as single string
+    local tfdocs_cmd=(
+      terraform-docs
+      --output-mode="$output_mode"
+      --output-file="$output_file"
+      $tf_docs_formatter
+      $args
+    )
+    if [[ $have_config_flag == true ]]; then
+      "${tfdocs_cmd[@]}" "--config=$config_file" ./ > /dev/null
+    else
+      "${tfdocs_cmd[@]}" ./ > /dev/null
+    fi
 
     popd > /dev/null
   done