2024-08-28 11:38:46 +08:00
|
|
|
|
# 构建 VitePress 站点并将其部署到 GitHub Pages 的示例工作流程
|
|
|
|
|
#
|
|
|
|
|
name: Deploy VitePress site to Pages
|
|
|
|
|
|
|
|
|
|
on:
|
|
|
|
|
# 在针对 `main` 分支的推送上运行。如果你
|
|
|
|
|
# 使用 `master` 分支作为默认分支,请将其更改为 `master`
|
|
|
|
|
push:
|
|
|
|
|
branches: [main]
|
|
|
|
|
|
|
|
|
|
# 允许你从 Actions 选项卡手动运行此工作流程
|
|
|
|
|
workflow_dispatch:
|
|
|
|
|
|
|
|
|
|
# 设置 GITHUB_TOKEN 的权限,以允许部署到 GitHub Pages
|
|
|
|
|
permissions:
|
|
|
|
|
contents: read
|
|
|
|
|
pages: write
|
|
|
|
|
id-token: write
|
|
|
|
|
|
|
|
|
|
# 只允许同时进行一次部署,跳过正在运行和最新队列之间的运行队列
|
|
|
|
|
# 但是,不要取消正在进行的运行,因为我们希望允许这些生产部署完成
|
|
|
|
|
concurrency:
|
|
|
|
|
group: pages
|
|
|
|
|
cancel-in-progress: false
|
|
|
|
|
|
|
|
|
|
jobs:
|
|
|
|
|
# 构建工作
|
|
|
|
|
build:
|
|
|
|
|
runs-on: ubuntu-latest
|
|
|
|
|
steps:
|
|
|
|
|
- name: Checkout
|
|
|
|
|
uses: actions/checkout@v4
|
|
|
|
|
with:
|
|
|
|
|
fetch-depth: 0 # 如果未启用 lastUpdated,则不需要
|
|
|
|
|
# - uses: pnpm/action-setup@v3 # 如果使用 pnpm,请取消注释
|
|
|
|
|
# - uses: oven-sh/setup-bun@v1 # 如果使用 Bun,请取消注释
|
2024-08-28 11:46:25 +08:00
|
|
|
|
- name: Setup Python
|
|
|
|
|
uses: actions/setup-python@v2
|
|
|
|
|
with:
|
|
|
|
|
python-version: '3.11'
|
|
|
|
|
|
|
|
|
|
- name: Setup API markdown
|
|
|
|
|
run: |-
|
|
|
|
|
python -m pip install pydantic
|
|
|
|
|
python docs/mkdoc.py
|
|
|
|
|
|
2024-08-28 11:52:22 +08:00
|
|
|
|
- name: 安装 pnpm
|
|
|
|
|
uses: pnpm/action-setup@v2
|
|
|
|
|
with:
|
|
|
|
|
run_install: true
|
|
|
|
|
version: 8
|
2024-08-28 11:48:40 +08:00
|
|
|
|
|
2024-08-28 11:52:22 +08:00
|
|
|
|
- name: 设置 Node.js
|
|
|
|
|
run: |-
|
2024-08-28 11:46:25 +08:00
|
|
|
|
cd docs
|
2024-08-28 11:52:22 +08:00
|
|
|
|
pnpm install
|
2024-08-28 11:46:25 +08:00
|
|
|
|
|
2024-08-28 11:52:22 +08:00
|
|
|
|
- name: 构建文档
|
|
|
|
|
env:
|
|
|
|
|
NODE_OPTIONS: --max_old_space_size=8192
|
2024-08-28 11:46:25 +08:00
|
|
|
|
run: |-
|
|
|
|
|
cd docs
|
2024-08-28 11:52:22 +08:00
|
|
|
|
pnpm run docs:build
|
2024-08-28 11:57:32 +08:00
|
|
|
|
> .vitepress/dist/.nojekyll
|
2024-08-28 11:46:25 +08:00
|
|
|
|
|
2024-08-28 11:52:22 +08:00
|
|
|
|
- name: 部署文档
|
|
|
|
|
uses: JamesIves/github-pages-deploy-action@v4
|
2024-08-28 11:38:46 +08:00
|
|
|
|
with:
|
2024-08-28 11:52:22 +08:00
|
|
|
|
# 这是文档部署到的分支名称
|
|
|
|
|
branch: gh-pages
|
|
|
|
|
folder: docs/.vuepress/dist
|