Merge branch 'master' into tfdocs-custom-markers

Author: MaxymVlasov

.git_archival.txt

@@ -0,0 +1,3 @@
+node: $Format:%H$
+node-date: $Format:%cI$
+describe-name: $Format:%(describe:tags=true)$

.gitattributes

@@ -0,0 +1 @@
+.git_archival.txt  export-subst

.github/CONTRIBUTING.md

@@ -1,11 +1,5 @@
 # Notes for contributors
 
-1. Python hooks are supported now too. All you have to do is:
-    1. add a line to the `console_scripts` array in `entry_points` in `setup.py`
-    2. Put your python script in the `pre_commit_hooks` folder
-
-Enjoy the clean, valid, and documented code!
-
 * [Run and debug hooks locally](#run-and-debug-hooks-locally)
 * [Run hook performance test](#run-hook-performance-test)
   * [Run via BASH](#run-via-bash)
@@ -18,6 +12,7 @@ Enjoy the clean, valid, and documented code!
   * [Prepare basic documentation](#prepare-basic-documentation)
   * [Add code](#add-code)
   * [Finish with the documentation](#finish-with-the-documentation)
+* [Contributing to Python code](#contributing-to-python-code)
 
 ## Run and debug hooks locally
 
@@ -152,5 +147,38 @@ You can use [this PR](https://github.com/antonbabenko/pre-commit-terraform/pull/
 
 ### Finish with the documentation
 
-1. Add hook description to [Available Hooks](../README.md#available-hooks).
+1. Add the hook description to [Available Hooks](../README.md#available-hooks).
 2. Create and populate a new hook section in [Hooks usage notes and examples](../README.md#hooks-usage-notes-and-examples).
+
+## Contributing to Python code
+
+1. [Install `tox`](https://tox.wiki/en/stable/installation.html)
+2. To run tests, run:
+
+    ```bash
+    tox -qq
+    ```
+
+    The easiest way to find out what parts of the code base are left uncovered, is to copy-paste and run the `python3 ...` command that will open the HTML report, so you can inspect it visually.
+
+3. Before committing any changes (if you do not have `pre-commit` installed locally), run:
+
+    ```bash
+    tox r -qq -e pre-commit
+    ```
+
+    Make sure that all checks pass.
+
+4. (Optional): If you want to limit the checks to MyPy only, you can run:
+
+    ```bash
+    tox r -qq -e pre-commit -- mypy --all-files
+    ```
+
+    Then copy-paste and run the `python3 ...` commands to inspect the strictest MyPy coverage reports visually.
+
+5. (Optional): You can find all available `tox` environments by running:
+
+    ```bash
+    tox list
+    ```

.github/renovate.json5

@@ -1,4 +1,8 @@
 {
   $schema: "https://docs.renovatebot.com/renovate-schema.json",
   extends: ["local>SpotOnInc/renovate-config"],
+  // To make happy 'Validate PR title' GHA
+  commitMessageLowerCase: "never",
+  // Disable auto-rebase on every commit to avoid reaching Github limits on macos runners
+  rebaseWhen: "conflicted",
 }

.github/workflows/build-image-test.yaml

@@ -16,14 +16,14 @@ jobs:
 
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332  # v4.1.7
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
       with:
         fetch-depth: 0
 
     - name: Get changed Docker related files
       id: changed-files-specific
       # yamllint disable-line rule:line-length
-      uses: tj-actions/changed-files@d6babd6899969df1a11d14c368283ea4436bca78  # v44.5.2
+      uses: tj-actions/changed-files@d6e91a2266cdb9d62096cebf1e8546899c6aa18f  # v45.0.6
       with:
         files: |
           Dockerfile
@@ -35,18 +35,18 @@ jobs:
     - name: Set up QEMU
       if: matrix.os != 'ubuntu-latest' || matrix.arch != 'amd64'
       # yamllint disable-line rule:line-length
-      uses: docker/setup-qemu-action@68827325e0b33c7199eb31dd4e31fbe9023e06e3  # v3.0.0
+      uses: docker/setup-qemu-action@53851d14592bedcffcf25ea515637cff71ef929a  # v3.3.0
       with:
         platforms: arm64
 
     - name: Set up Docker Buildx
       # yamllint disable-line rule:line-length
-      uses: docker/setup-buildx-action@d70bba72b1f3fd22344832f00baa16ece964efeb  # v3.3.0
+      uses: docker/setup-buildx-action@6524bf65af31da8d45b59e8c27de4bd072b392f5  # v3.8.0
 
     - name: Build if Dockerfile changed
       if: steps.changed-files-specific.outputs.any_changed == 'true'
       # yamllint disable-line rule:line-length
-      uses: docker/build-push-action@94f8f8c2eec4bc3f1d78c1755580779804cb87b2  # v6.0.1
+      uses: docker/build-push-action@b32b51a8eda65d6793cd0494a773d4f6bcef32dc  # v6.11.0
       with:
         context: .
         build-args: |
@@ -88,7 +88,7 @@ jobs:
         && matrix.os == 'ubuntu-latest'
         && matrix.arch == 'amd64'
       # yamllint disable-line rule:line-length
-      uses: docker/build-push-action@94f8f8c2eec4bc3f1d78c1755580779804cb87b2  # v6.0.1
+      uses: docker/build-push-action@b32b51a8eda65d6793cd0494a773d4f6bcef32dc  # v6.11.0
       with:
         context: .
         build-args: |

.github/workflows/build-image.yaml

@@ -15,16 +15,16 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout code
-      uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332  # v4.1.7
+      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
     - name: Set up QEMU
       # yamllint disable-line rule:line-length
-      uses: docker/setup-qemu-action@68827325e0b33c7199eb31dd4e31fbe9023e06e3  # v3.0.0
+      uses: docker/setup-qemu-action@53851d14592bedcffcf25ea515637cff71ef929a  # v3.3.0
     - name: Set up Docker Buildx
       # yamllint disable-line rule:line-length
-      uses: docker/setup-buildx-action@d70bba72b1f3fd22344832f00baa16ece964efeb  # v3.3.0
+      uses: docker/setup-buildx-action@6524bf65af31da8d45b59e8c27de4bd072b392f5  # v3.8.0
     - name: Login to GitHub Container Registry
       # yamllint disable-line rule:line-length
-      uses: docker/login-action@0d4c9c5ea7693da7b068278f7b52bda2a190a446  # v3.2.0
+      uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567  # v3.3.0
       with:
         registry: ghcr.io
         username: ${{ github.repository_owner }}
@@ -39,12 +39,12 @@ jobs:
 
     - name: Set up Docker Buildx
       # yamllint disable-line rule:line-length
-      uses: docker/setup-buildx-action@d70bba72b1f3fd22344832f00baa16ece964efeb  # v3.3.0
+      uses: docker/setup-buildx-action@6524bf65af31da8d45b59e8c27de4bd072b392f5  # v3.8.0
 
     - name: Build and Push release
       if: github.event_name != 'schedule'
       # yamllint disable-line rule:line-length
-      uses: docker/build-push-action@94f8f8c2eec4bc3f1d78c1755580779804cb87b2  # v6.0.1
+      uses: docker/build-push-action@b32b51a8eda65d6793cd0494a773d4f6bcef32dc  # v6.11.0
       with:
         context: .
         build-args: |
@@ -62,7 +62,7 @@ jobs:
     - name: Build and Push nightly
       if: github.event_name == 'schedule'
       # yamllint disable-line rule:line-length
-      uses: docker/build-push-action@94f8f8c2eec4bc3f1d78c1755580779804cb87b2  # v6.0.1
+      uses: docker/build-push-action@b32b51a8eda65d6793cd0494a773d4f6bcef32dc  # v6.11.0
       with:
         context: .
         build-args: |

.github/workflows/ci-cd.yml

@@ -106,11 +106,13 @@ jobs:
 
     steps:
     - name: Switch to using Python 3.13 by default
-      uses: actions/setup-python@v5
+      # yamllint disable-line rule:line-length
+      uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b  # v5.3.0
       with:
         python-version: 3.13
     - name: Check out src from Git
-      uses: actions/checkout@v4
+      # yamllint disable-line rule:line-length
+      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
       with:
         fetch-depth: 0
     - name: >-
@@ -162,7 +164,8 @@ jobs:
         echo "dir=$(python -m pip cache dir)" >> "${GITHUB_OUTPUT}"
       shell: bash
     - name: Set up pip cache
-      uses: actions/cache@v4
+      # yamllint disable-line rule:line-length
+      uses: actions/cache@1bd1e32a3bdc45362d1e726936510720a7c30a57  # v4.2.0
       with:
         path: ${{ steps.pip-cache-dir.outputs.dir }}
         key: >-
@@ -268,12 +271,14 @@ jobs:
 
     steps:
     - name: Switch to using Python 3.13
-      uses: actions/setup-python@v5
+      # yamllint disable-line rule:line-length
+      uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b  # v5.3.0
       with:
         python-version: 3.13
 
     - name: Grab the source from Git
-      uses: actions/checkout@v4
+      # yamllint disable-line rule:line-length
+      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
       with:
         fetch-depth: 0
 
@@ -301,7 +306,8 @@ jobs:
       run: >-
         echo "dir=$(python -m pip cache dir)" >> "${GITHUB_OUTPUT}"
     - name: Set up pip cache
-      uses: actions/cache@v4
+      # yamllint disable-line rule:line-length
+      uses: actions/cache@1bd1e32a3bdc45362d1e726936510720a7c30a57  # v4.2.0
       with:
         path: ${{ steps.pip-cache-dir.outputs.dir }}
         key: >-
@@ -359,7 +365,8 @@ jobs:
         >> "${GITHUB_OUTPUT}"
       working-directory: dist
     - name: Store the distribution packages
-      uses: actions/upload-artifact@v4
+      # yamllint disable-line rule:line-length
+      uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08  # v4.6.0
       with:
         name: >-
           ${{ needs.pre-setup.outputs.dists-artifact-name }}

.github/workflows/pr-title.yml

@@ -17,7 +17,7 @@ jobs:
     # Please look up the latest version from
     # https://github.com/amannn/action-semantic-pull-request/releases
     # yamllint disable-line rule:line-length
-    - uses: amannn/action-semantic-pull-request@cfb60706e18bc85e8aec535e3c577abe8f70378e  # v5.5.2
+    - uses: amannn/action-semantic-pull-request@0723387faaf9b38adef4775cd42cfd5155ed6017  # v5.5.3
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       with:

.github/workflows/pre-commit.yaml

@@ -8,7 +8,7 @@ jobs:
   pre-commit:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332  # v4.1.7
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
     - run: >-
         git fetch --no-tags --prune --depth=1 origin
         +refs/heads/*:refs/remotes/origin/*
@@ -44,13 +44,13 @@ jobs:
         > hadolint
         && chmod +x hadolint && sudo mv hadolint /usr/bin/
     # Need to success pre-commit fix push
-    - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332  # v4.1.7
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
       with:
         fetch-depth: 0
         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@82c7e631bb3cdc910f68e0081d67478d79c6982d  # v5.1.0
+    - uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b  # v5.3.0
       with:
         python-version: '3.9'
     - name: Execute pre-commit

.github/workflows/release.yml

@@ -20,14 +20,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout
-      uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332  # v4.1.7
+      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
       with:
         persist-credentials: false
         fetch-depth: 0
 
     - name: Release
       # yamllint disable-line rule:line-length
-      uses: cycjimmy/semantic-release-action@cb425203a562475bca039ba4dbf90c7f9ac790f4  # v4.1.0
+      uses: cycjimmy/semantic-release-action@b1b432f13acb7768e0c8efdec416d363a57546f2  # v4.1.1
       with:
         semantic_version: 18.0.0
         extra_plugins: |