refactor(docs): 将文档构建工具从 DocFX 迁移到 VitePress

- 移除 .NET SDK 相关配置,改为使用 Node.js 环境
- 更新依赖安装方式,使用 npm 替代 dotnet restore
- 修改构建命令为 npm run build,替换原有的 DocFX 构建流程
- 调整输出路径配置,从 docfx/_site 改为 docs/.vitepress/dist
- 更新工作流触发条件,启用 push 触发器替代手动触发
- 重命名作业名称为 build-and-deploy,简化部署流程
- 更新 Action 版本号,统一使用较新的版本
- [release ci]
This commit is contained in:
GeWuYou 2026-02-11 12:42:55 +08:00 committed by gewuyou
parent 590bbbf81b
commit 8f30361972

View File

@ -1,106 +1,61 @@
# 工作流名称Publish Docs
# 该工作流用于在推送到 main 分支时自动构建并发布文档到 GitHub Pages。
# 暂时关了,目前这个文档生成有问题,以后再改
# 工作流名称Publish Docs (VitePress)
name: Publish Docs
# 触发条件:
# 定义工作流的触发规则。当代码仓库发生特定事件时,将自动执行相关操作。
# 此处配置表示当向仓库推送push带有标签tag的提交时触发工作流。
# 标签匹配规则为通配符 '*',即任意标签都会触发。
on:
# push:
# branches:
# - '**'
# tags:
# - '*'
workflow_dispatch:
# 权限配置:指定工作流所需的权限。
# actions: read - 允许读取 GitHub Actions 相关信息。
# pages: write - 允许写入 GitHub Pages 内容。
# id-token: write - 允许写入身份令牌(用于部署认证)。
push:
branches:
- '**'
tags:
- '*'
permissions:
actions: read
contents: read
pages: write
id-token: write
# 并发控制:确保同一组任务不会同时运行。
# group: "pages" - 将并发任务分组为 "pages"。
# cancel-in-progress: false - 不取消正在进行的任务。
concurrency:
group: "pages"
cancel-in-progress: false
# 定义工作流中的作业。
# if 条件表达式用于判断是否执行该作业。
# 表达式逻辑如下:
# 1. startsWith(github.ref, 'refs/tags/'):检查当前引用是否以 'refs/tags/' 开头,即是否为标签推送。
# 2. contains(github.event.head_commit.message, '[release doc]'):检查提交信息中是否包含 '[release doc]' 字符串。
# 若任一条件满足,则执行该作业。
jobs:
# 作业名称publish-docs负责构建和发布文档。
publish-docs:
if: |
startsWith(github.ref, 'refs/tags/')
|| contains(github.event.head_commit.message, '[release doc]')
# 运行环境:使用最新版本的 Ubuntu 虚拟机。
build-and-deploy:
runs-on: ubuntu-latest
# 环境配置:指定部署的目标环境为 github-pages并设置页面 URL。
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
# 步骤定义:按顺序执行一系列操作以完成文档构建与发布。
steps:
# 步骤 1检出代码仓库。
# 1⃣ 拉取仓库代码
- name: Checkout
uses: actions/checkout@v6
uses: actions/checkout@v4
# 步骤 2安装 .NET SDK。
- name: Setup .NET
uses: actions/setup-dotnet@v5
# 2⃣ 安装 Node.js
- name: Setup Node
uses: actions/setup-node@v4
with:
dotnet-version: 10.0.x
node-version: 20
cache: 'npm'
# 步骤 3恢复项目依赖项。
- name: Restore
run: dotnet restore
# 步骤 4构建项目并生成 XML 文档。
- name: Build (generate XML docs)
run: dotnet build -c Release
# 步骤 5安装 DocFX 工具。
- name: Install DocFX
run: dotnet tool update -g docfx
# 步骤 6使用 DocFX 构建静态站点。
- name: Build DocFX
# 3⃣ 安装依赖
- name: Install Dependencies
run: |
export PATH="$PATH:$HOME/.dotnet/tools"
cd docfx
docfx metadata
docfx build
cd docs
npm install
- name: Debug DocFX output
# 4⃣ 构建 VitePress
- name: Build VitePress
run: |
echo "==== docfx directory ===="
ls -la docfx || true
cd docs
npm run build
echo "==== _site directory ===="
ls -la docfx/_site || echo "_site not found"
echo "==== _site content ===="
find docfx/_site | head -n 50 || true
# 步骤 7上传构建好的静态站点文件作为工件。
# 5⃣ 上传构建产物
- name: Upload Pages Artifact
uses: actions/upload-pages-artifact@v3
with:
path: docfx/_site
path: docs/.vitepress/dist
# 步骤 8将静态站点部署到 GitHub Pages。
# 6⃣ 部署到 GitHub Pages
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4