docs_lint.yaml

# Copyright 2026 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: Lint Documentation

on:
  pull_request:
    paths:
      - 'docs/**'
      - '.github/workflows/docs**'
      - '.ci/lint-docs-*.sh'

jobs:
  lint-source-pages:
    name: Validate Source Page Structure
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.x'

      - name: Check for large files in docs/
        run: |
          if [ -d "docs" ]; then
            LARGE_FILES=$(find docs/ -type f -size +24M)
            if [ -n "$LARGE_FILES" ]; then
              echo "Error: The following files in the docs/ directory exceed the 24MB size limit:"
              echo "$LARGE_FILES"
              exit 1
            else
              echo "Success: No files in docs/ exceed 24MB."
            fi
          else
            echo "Info: docs/ directory not found. Skipping file size check."
          fi

      - name: Make scripts executable
        run: chmod +x .ci/lint-docs-*.sh

      - name: Run Structure Linter for Source Pages
        run: .ci/lint-docs-source-page.sh

      - name: Run Structure Linter for Tool Pages
        run: .ci/lint-docs-tool-page.sh