linting.yml

# Copyright 2025 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: "Linting"
# yamllint disable-line rule:truthy
on:
  pull_request:
    branches:
      - master
  push:
    branches:
      - master
  merge_group:
    branches:
      - master

permissions:
  contents: read

jobs:
  linting:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
        with:
          persist-credentials: false

      - name: Set up Python
        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5
        with:
          python-version: "3.10"
          cache: 'pip'
          cache-dependency-path: 'tools/requirements.txt'

      - name: Set up Terraform
        uses: hashicorp/setup-terraform@b9cd54a3c349d3f38e8881555d616ced269862dd # v3
        with:
          terraform_version: 1.11.4

      - uses: terraform-linters/setup-tflint@6e87008f9dd1fe3e34e66aca6c97b4a69f72a7f4 # v4
        name: Setup TFLint
        with:
          tflint_version: v0.59.1

      - name: Init TFLint
        run: |
          cp .tflint.hcl ~
          tflint --init
        env:
          # https://github.com/terraform-linters/tflint/blob/master/docs/user-guide/plugins.md#avoiding-rate-limiting
          GITHUB_TOKEN: ${{ github.token }}

      - name: Install dependencies
        run: |
          pip install -r tools/requirements.txt

      - name: Boilerplate
        id: boilerplate
        run: |
          python3 tools/check_boilerplate.py $GITHUB_WORKSPACE

      - name: Terraform Linting Check
        id: fmt
        run: |
          terraform fmt -recursive -check -diff $GITHUB_WORKSPACE

      - name: TFLint Modules
        run: cd modules && tflint --recursive -f compact

      - name: TFLint FAST
        run: |
          python3 tools/tflint-fast.py

      - name: Check documentation
        id: documentation-fabric
        run: |
          python3 tools/check_documentation.py --show-diffs --no-show-summary modules fast

      - name: Check schema docs
        id: schema-docs
        run: |
          python3 tools/check_schema_docs.py --show-diffs --no-show-summary modules fast blueprints

      - name: Check documentation links
        id: documentation-links-fabric
        run: |
          python3 tools/check_links.py --no-show-summary .

      - name: Check name length (fast)
        id: name-length-fast
        run: |
          python3 tools/check_names.py --prefix-length=10 --failed-only fast/stages

      - name: Check YAML schemas
        id: yaml-schema
        run: |
          python3 tools/check_yaml_schema.py modules fast

      - name: Check python formatting
        id: yapf
        uses: pre-commit/action@1b06ec171f2f6faa71ed760c4042bd969e4f8b43
        with:
          extra_args: yapf --all-files

      - name: Check modules versions
        id: versions
        uses: pre-commit/action@1b06ec171f2f6faa71ed760c4042bd969e4f8b43
        with:
          extra_args: versions --all-files

      - name: Check for diverging files
        id: duplicates
        uses: pre-commit/action@1b06ec171f2f6faa71ed760c4042bd969e4f8b43
        with:
          extra_args: duplicate-diff --all-files

      - name: Check YAML files
        id: yaml-lint
        uses: pre-commit/action@1b06ec171f2f6faa71ed760c4042bd969e4f8b43
        with:
          extra_args: yamllint --all-files

      - name: Check for spelling mistakes
        id: codespell
        uses: pre-commit/action@1b06ec171f2f6faa71ed760c4042bd969e4f8b43
        with:
          extra_args: codespell --all-files