docs #36
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: docs | |
on: | |
# trigger deployment on every push to main branch | |
workflow_dispatch: | |
jobs: | |
docs: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
with: | |
# fetch all commits to get last updated time or other git log info | |
fetch-depth: 0 | |
- name: Setup Node.js | |
uses: actions/setup-node@v3 | |
with: | |
# choose node.js version to use | |
node-version: "14" | |
- uses: pnpm/action-setup@v2.0.1 | |
name: Install pnpm --no-frozen-lockfile | |
id: pnpm-install | |
with: | |
version: 7 | |
run_install: false | |
# - name: Get pnpm store directory | |
# id: pnpm-cache | |
# working-directory: "docs" | |
# run: | | |
# echo "::set-output name=pnpm_cache_dir::$(pnpm store path)" | |
# - uses: actions/cache@v3 | |
# name: Setup pnpm cache | |
# with: | |
# path: ${{ steps.pnpm-cache.outputs.pnpm_cache_dir }} | |
# key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }} | |
# restore-keys: | | |
# ${{ runner.os }}-pnpm-store- | |
- name: Install dependencies | |
working-directory: "docs" | |
run: pnpm install --no-frozen-lockfile | |
# run build script | |
- name: Build VuePress site | |
working-directory: "docs" | |
run: pnpm run build | |
# please check out the docs of the workflow for more details | |
# @see https://github.com/crazy-max/ghaction-github-pages | |
- name: Deploy to GitHub Pages | |
uses: crazy-max/ghaction-github-pages@v2 | |
with: | |
# deploy to gh-pages branch | |
target_branch: gh-pages | |
# deploy the default output dir of VuePress | |
build_dir: docs/src/.vuepress/dist | |
env: | |
# @see https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |