Skip to content

docs: update docs #5394

docs: update docs

docs: update docs #5394

Workflow file for this run

name: doc-generator
on:
push:
branches:
- main
pull_request:
branches:
- '**'
concurrency:
group: doc-generator-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true
permissions:
contents: read
jobs:
checks:
if: github.event_name != 'push'
runs-on: ubuntu-latest
steps:
- name: Checkout 🛎️
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 # If you're using actions/checkout@v2 you must set persist-credentials to false in most cases for the deployment to work correctly.
with:
persist-credentials: false
- name: Install and Build 🔧
run: |
cd website
npm ci
npm run build
build-and-deploy:
permissions:
contents: write # for JamesIves/github-pages-deploy-action to push changes in repo
if: github.event_name != 'pull_request'
runs-on: ubuntu-latest
steps:
- name: Checkout 🛎️
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 # If you're using actions/checkout@v2 you must set persist-credentials to false in most cases for the deployment to work correctly.
with:
persist-credentials: false
- name: Install and Build 🔧
run: |
cd website
npm ci
npm run build
- name: Deploy 🚀
uses: JamesIves/github-pages-deploy-action@62fec3add6773ec5dbbf18d2ee4260911aa35cf4 # v4.6.9
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
BRANCH: gh-pages # The branch the action should deploy to.
FOLDER: website/build # The folder the action should deploy.
CLEAN: true # Automatically remove deleted files from the deploy branch