zrok/.github/workflows/deploy-doc-site.yml

48 lines
1.5 KiB
YAML
Raw Normal View History

name: Deploy Doc Site
on:
push:
branches:
- main
# allow GITHUB_TOKEN to be used by the peaceiris/actions-gh-pages action to push to gh-pages branch
permissions:
contents: write
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
name: setup npm
with:
node-version: 18
check-latest: true
cache: "npm"
cache-dependency-path: website/package-lock.json
- name: Run a multi-line script
run: |
npm install
npm run build
working-directory: website
# Popular action to deploy to GitHub Pages:
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Build output to publish to the `gh-pages` branch:
publish_dir: ./website/build
# The following lines assign commit authorship to the official
# GH-Actions bot for deploys to `gh-pages` branch:
# https://github.com/actions/checkout/issues/13#issuecomment-724415212
# The GH actions bot is used by default if you didn't specify the two fields.
# You can swap them out with your own user credentials.
#user_name: github-actions[bot]
#user_email: 41898282+github-actions[bot]@users.noreply.github.com