-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
30 additions
and
34 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,51 +1,47 @@ | ||
name: docs | ||
|
||
name: Deploy Docs | ||
|
||
on: | ||
# trigger deployment on every push to main branch | ||
push: | ||
branches: [main] | ||
# trigger deployment manually | ||
workflow_dispatch: | ||
branches: | ||
# make sure this is the branch you are using | ||
- main | ||
|
||
permissions: | ||
contents: write | ||
|
||
jobs: | ||
docs: | ||
deploy-gh-pages: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: Checkout | ||
uses: actions/checkout@v3 | ||
with: | ||
# fetch all commits to get last updated time or other git log info | ||
fetch-depth: 0 | ||
# if your docs needs submodules, uncomment the following line | ||
# submodules: true | ||
|
||
|
||
- name: Setup pnpm | ||
uses: pnpm/action-setup@v2 | ||
with: | ||
# choose pnpm version to use | ||
version: 8 | ||
# install deps with pnpm | ||
run_install: true | ||
|
||
- name: Setup Node.js | ||
uses: actions/setup-node@v4 | ||
uses: actions/setup-node@v3 | ||
with: | ||
# choose node.js version to use | ||
node-version: 20 | ||
# cache deps for pnpm | ||
cache: pnpm | ||
cache: npm | ||
|
||
# run build script | ||
- name: Build VuePress site | ||
run: pnpm docs:build | ||
- name: Install Deps | ||
run: npm ci | ||
|
||
# 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@v4 | ||
with: | ||
# deploy to gh-pages branch | ||
target_branch: gh-pages | ||
# deploy the default output dir of VuePress | ||
build_dir: docs/.vuepress/dist | ||
- name: Build Docs | ||
env: | ||
# @see https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
NODE_OPTIONS: --max_old_space_size=8192 | ||
run: |- | ||
npm run docs:build | ||
> docs/.vuepress/dist/.nojekyll | ||
- name: Deploy Docs | ||
uses: JamesIves/github-pages-deploy-action@v4 | ||
with: | ||
# This is the branch where the docs are deployed to | ||
branch: gh-pages | ||
folder: docs/.vuepress/dist |