deploy #232
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: deploy-docs-site | |
on: | |
# 每当 push 到 main 分支时触发部署 | |
push: | |
branches: [main] | |
# 手动触发部署 | |
workflow_dispatch: | |
jobs: | |
docs-github: | |
runs-on: ubuntu-latest | |
timeout-minutes: 10 | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
# “最近更新时间” 等 git 日志相关信息,需要拉取全部提交记录 | |
fetch-depth: 0 | |
- name: Setup Node.js | |
uses: actions/setup-node@v4 | |
with: | |
# 选择要使用的 node 版本 | |
node-version: 20 | |
registry-url: https://registry.npmmirror.com/ | |
- uses: pnpm/action-setup@v3 | |
name: Install pnpm | |
id: pnpm-install | |
with: | |
version: 9 | |
run_install: false | |
- name: Get pnpm store directory | |
id: pnpm-cache | |
run: | | |
echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV | |
- uses: actions/cache@v4 | |
name: Setup pnpm cache | |
with: | |
path: ${{ env.STORE_PATH }} | |
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }} | |
restore-keys: | | |
${{ runner.os }}-pnpm-store- | |
- name: Install antfu/ni | |
run: npm i -g @antfu/ni | |
- name: Install dependencies | |
run: ni --frozen | |
# 运行构建脚本 | |
- name: Build VitePress site | |
run: nr build | |
# 查看 workflow 的文档来获取更多信息 | |
# @see https://github.com/crazy-max/ghaction-github-pages | |
- name: Deploy to GitHub Pages | |
uses: crazy-max/ghaction-github-pages@v3 | |
with: | |
# 部署到 gh-pages 分支 | |
target_branch: gh-pages | |
# 部署目录为 VitePress 的默认输出目录 | |
build_dir: .vitepress/dist | |
env: | |
# @see https://docs.github.com/cn/actions/reference/authentication-in-a-workflow#about-the-github_token-secret | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
# docs-gitee: | |
# needs: docs-github | |
# runs-on: ubuntu-latest | |
# timeout-minutes: 10 | |
# steps: | |
# - name: Sync to Gitee | |
# uses: wearerequired/git-mirror-action@master | |
# env: | |
# # 注意在 Settings->Secrets 配置 GITEE_RSA_PRIVATE_KEY | |
# SSH_PRIVATE_KEY: ${{ secrets.GITEE_RSA_PRIVATE_KEY }} | |
# with: | |
# # 注意替换为你的 GitHub 源仓库地址 | |
# source-repo: git@github.com:fantastic-admin/fantastic-admin.hurui.me.git | |
# # 注意替换为你的 Gitee 目标仓库地址 | |
# destination-repo: git@gitee.com:fantastic-admin/fantastic-admin.git | |
# - name: Build Gitee Pages | |
# uses: yanglbme/gitee-pages-action@main | |
# with: | |
# # 注意替换为你的 Gitee 用户名 | |
# gitee-username: hooray | |
# # 注意在 Settings->Secrets 配置 GITEE_PASSWORD | |
# gitee-password: ${{ secrets.GITEE_PASSWORD }} | |
# # 注意替换为你的 Gitee 仓库,仓库名严格区分大小写,请准确填写,否则会出错 | |
# gitee-repo: fantastic-admin/fantastic-admin | |
# # 要部署的分支,默认是 master,若是其他分支,则需要指定(指定的分支必须存在) | |
# branch: gh-pages |