Skip to content

Update docs

Update docs #13

Workflow file for this run

name: Deploy Docs
on:
push:
paths:
- 'docs/**'
branches:
- main
concurrency:
group: ${{ github.workflow }}-${{ github.ref_name }}
cancel-in-progress: true
jobs:
build:
name: Create Pages Artifact
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v3
with:
cache-dependency-path: ./docs/yarn.lock
node-version: 18
cache: yarn
- name: Install dependencies
working-directory: ./docs
run: yarn install --frozen-lockfile
- name: Build website
working-directory: ./docs
run: yarn build
- name: Fix permissions
working-directory: ./docs
run: |
chmod -c -R +rX "build/" | while read line; do
echo "::warning title=Invalid file permissions automatically fixed::$line"
done
- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v2
with:
path: ./docs/build
deploy:
name: Deploy to GitHub Pages
needs: build
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
- name: Delete Artifact
if: always()
uses: geekyeggo/delete-artifact@v2
with:
name: github-pages