link-checker.yaml

# 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: Check external links

on:
  push:
    branches:
      - main
  pull_request:

jobs:
  link-check:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v6

    - name: Check links
      uses: lycheeverse/lychee-action@v2
      with:
        args: >-
          --verbose
          --no-progress
          --max-retries 5
          --retry-wait-time 3
          --host-concurrency 2
          --host-request-interval 1s
          --root-dir "$(pwd)/docs"
          './**/*.md'
        fail: true
        failIfEmpty: true
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}