diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index 1a9548aa..171e2214 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -1,61 +1,70 @@ - -name: 部署文档 +# 构建 VitePress 站点并将其部署到 GitHub Pages 的示例工作流程 +# +name: Deploy VitePress site to Pages on: + # 在针对 `main` 分支的推送上运行。如果你 + # 使用 `master` 分支作为默认分支,请将其更改为 `master` push: - branches: - # 确保这是你正在使用的分支名称 - - main + branches: [main] + # 允许你从 Actions 选项卡手动运行此工作流程 + workflow_dispatch: + +# 设置 GITHUB_TOKEN 的权限,以允许部署到 GitHub Pages permissions: contents: write +# 只允许同时进行一次部署,跳过正在运行和最新队列之间的运行队列 +# 但是,不要取消正在进行的运行,因为我们希望允许这些生产部署完成 +concurrency: + group: pages + cancel-in-progress: false + jobs: - deploy-gh-pages: + # 构建工作 + build: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: - fetch-depth: 0 - # 如果你文档需要 Git 子模块,取消注释下一行 -# submodules: true + fetch-depth: 0 # 如果未启用 lastUpdated,则不需要 + # - uses: pnpm/action-setup@v3 # 如果使用 pnpm,请取消注释 + # - uses: oven-sh/setup-bun@v1 # 如果使用 Bun,请取消注释 + - name: Setup Python + uses: actions/setup-python@v2 + with: + python-version: '3.11' + + - name: Setup API markdown + run: |- + python -m pip install litedoc + litedoc liteyuki -o docs/zh/dev/api -l zh-Hans -cd class -fd def -md def -vd var -cs -bu https://github.com/LiteyukiStudio/LiteyukiBot/tree/main/liteyuki/ + litedoc liteyuki -o docs/en/dev/api -l en -cd class -fd def -md def -vd var -cs -bu https://github.com/LiteyukiStudio/LiteyukiBot/tree/main/liteyuki/ + - name: 安装 pnpm uses: pnpm/action-setup@v2 with: run_install: true version: 8 - - name: 设置 Node.js run: |- cd docs pnpm install - - name: 设置Python - uses: actions/setup-python@v2 - with: - python-version: '3.10' - - - - name: 生成API markdown - run: |- - python -m pip install litedoc - litedoc liteyuki -o docs/zh/dev/api -l zh-Hans -cd class -fd def -md def -vd var -cs -bu https://github.com/LiteyukiStudio/LiteyukiBot/tree/main/liteyuki/ - litedoc liteyuki -o docs/en/dev/api -l en -cd class -fd def -md def -vd var -cs -bu https://github.com/LiteyukiStudio/LiteyukiBot/tree/main/liteyuki/ - - - name: 构建文档 env: NODE_OPTIONS: --max_old_space_size=8192 run: |- cd docs pnpm run docs:build - > .vuepress/dist/.nojekyll + > .vitepress/dist/.nojekyll - name: 部署文档 uses: JamesIves/github-pages-deploy-action@v4 with: # 这是文档部署到的分支名称 - branch: gh-pages - folder: docs/.vuepress/dist + branch: docs + folder: docs/.vitepress/dist \ No newline at end of file