check.yml

# 文档质量检查工作流
# - push 到 dev 分支时触发
# - 向 dev 分支提 PR 时触发（作为合并前的强制质量门）
# 功能：使用 lychee 检查文档中的 broken links，结果输出为 artifact

name: Check Action

on:
  workflow_dispatch:
  push:
    branches:
      - dev
  pull_request:
    branches:
      - dev

jobs:
  broken-links:
    name: Broken Links Check
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Check broken links
        uses: lycheeverse/lychee-action@v2
        with:
          args: >-
            --verbose
            --no-progress
            --exclude-path node_modules
            --exclude-path build
            versioned_docs/
            i18n/
          fail: false
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: Upload lychee results
        uses: actions/upload-artifact@v4
        if: always()
        with:
          name: lychee-report
          path: lychee/out.md
          retention-days: 7