知識庫設定與 GitHub Pages 部署指南¶

name: CI - Syntax & Lint Check

on:
  pull_request:
    branches:
      - main

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  markdown-lint:
    name: Markdown Lint Check
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
      - name: 執行 Markdown Lint 語法檢查
        uses: DavidAnson/markdownlint-cli2-action@v24
        with:
          globs: "**/*.md"

  build-check:
    name: MkDocs Build Check
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
        with:
          fetch-depth: 0 # 完整抓取 Git 歷史紀錄以支援 git-* 外掛
          ref: ${{ github.head_ref || github.ref }}
      - uses: actions/setup-python@v7
        with:
          python-version: "3.12"
          cache: "pip"
      - run: pip install -r requirements.txt
      - name: 檢查 MkDocs 語法與站點建置 (嚴格模式)
        env:
          MKDOCS_GIT_COMMITTERS_APIKEY: ${{ secrets.GITHUB_TOKEN }}
          DISABLE_MKDOCS_2_WARNING: "true"
        run: mkdocs build --strict

name: Deploy MkDocs to GitHub Pages

on:
  push:
    branches:
      - main  # 當 PR 合併至 main 時觸發

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7
        with:
          fetch-depth: 0 # 完整抓取 Git 歷史紀錄以支援 git-* 外掛
      - uses: actions/setup-python@v7
        with:
          python-version: "3.12"
          cache: "pip"
      - run: pip install -r requirements.txt
      - run: mkdocs build
        env:
          MKDOCS_GIT_COMMITTERS_APIKEY: ${{ secrets.GITHUB_TOKEN }}
          DISABLE_MKDOCS_2_WARNING: "true"
      - uses: actions/upload-pages-artifact@v5
        with:
          path: ./site
      - id: deployment
        uses: actions/deploy-pages@v5