ScriptsForMinecraftServer/.github/workflows/docs.yml at main · DogeLakeDev/ScriptsForMinecraftServer · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
name: Docs

# MkDocs Material → GitHub Pages
# 站点：https://dogelakedev.github.io/ScriptsForMinecraftServer/

on:
  push:
    branches: [main]
    paths:
      - "docs/**"
      - "mkdocs.yml"
      - "typedoc.json"
      - "tools/docs.mjs"
      - "tools/docs-*.mjs"
      - "modules/sdk/@sfmc-sdk/src/**"
      - "modules/sdk/@sfmc-sdk/tsconfig.typedoc.json"
      - "package.json"
      - "package-lock.json"
      - ".github/workflows/docs.yml"
  workflow_dispatch:

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

concurrency:
  group: pages-docs
  cancel-in-progress: true

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          # git-revision-date-localized 需要完整历史，浅克隆会导致日期全变成最近一次 commit
          fetch-depth: 0

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: "22"
          cache: npm

      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.12"
          cache: pip
          cache-dependency-path: docs/requirements.txt

      - name: Install dependencies
        run: |
          npm ci
          pip install -r docs/requirements.txt

      - name: Build docs (TypeDoc + MkDocs)
        run: npm run docs -- build

      - name: Upload Pages artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: site

  deploy:
    needs: build
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4