This repository has been archived by the owner on Sep 18, 2023. It is now read-only.
Create README.md #55
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 | |
push: | |
branches: [main] | |
# trigger deployment manually | |
workflow_dispatch: | |
jobs: | |
docs: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- name: Setup Node.js | |
uses: actions/setup-node@v3 | |
with: | |
# choose node.js version to use | |
node-version: 18 | |
# cache node_modules | |
- name: Cache dependencies | |
uses: actions/cache@v3 | |
id: yarn-cache | |
with: | |
path: | | |
**/node_modules | |
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} | |
restore-keys: | | |
${{ runner.os }}-yarn- | |
# install dependencies if the cache did not hit | |
- name: Install dependencies | |
if: steps.yarn-cache.outputs.cache-hit != 'true' | |
run: yarn --frozen-lockfile | |
# run build script | |
- name: Build VuePress site | |
run: yarn docs: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/.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 }} |