Skip to content

fix docs workflow

fix docs workflow #27

name: Test Deploy Docs
on:
push:
paths:
- 'www/**'
- '.github/workflows/docs-build-test-and-deploy.yml'
workflow_dispatch:
# Review gh actions docs if you want to further define triggers, paths, etc
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
jobs:
test-and-deploy:
name: Test and deploy
runs-on: ubuntu-latest
permissions:
contents: write
defaults:
run:
working-directory: www
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 18
cache: yarn
cache-dependency-path: './www/yarn.lock'
- name: Install dependencies
run: yarn install --frozen-lockfile
- name: Test build website
run: yarn build
- name: Deploy to GitHub Pages
if: github.ref == 'refs/heads/main'
# Popular action to deploy to GitHub Pages:
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Build output to publish to the `gh-pages` branch:
publish_dir: ./www/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