Skip to content

4

4 #16

Workflow file for this run

name: docs
on:
push:
branches:
- docs
paths:
- 'docs/**'
- '.github/workflows/deploy-docs.yml'
pull_request:
branches:
- main
paths:
- 'docs/**'
- '.github/workflows/deploy-docs.yml'
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
# “最近更新时间” 等 git 日志相关信息,需要拉取全部提交记录
fetch-depth: 0
- name: Setup Node.js
uses: actions/setup-node@v1
with:
# 选择要使用的 node 版本
node-version: '18.8.0'
- name: Install pnpm
uses: pnpm/action-setup@v2
with:
version: 7.17.0
# 如果缓存没有命中,安装依赖
- name: Install dependencies
run: pnpm install --dir docs
# 运行构建脚本
- name: Build VitePress site
run: cd docs && pnpm run build-no-prefetch
# 查看 workflow 的文档来获取更多信息
# @see https://github.com/crazy-max/ghaction-github-pages
- name: Deploy to GitHub Pages
uses: crazy-max/ghaction-github-pages@v2
with:
# 部署到 gh-pages 分支
target_branch: gh-pages
# 部署目录为 VuePress 的默认输出目录
build_dir: ./docs/.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 }}