.github/workflows/deploy-docs.yml
name: Deploy typedoc to github
on:
push:
branches:
- main
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
ref: ${{ github.head_ref }}
fetch-depth: 0
- uses: actions/setup-node@v3
with:
node-version: "18.17.1"
- name: npm auth
run: |
echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" > .npmrc
- name: install
run: yarn install
- name: compile
run: yarn xy compile
env:
NODE_OPTIONS: "--max-old-space-size=8192"
- name: typedoc build
run: yarn build-typedoc-site
env:
NODE_OPTIONS: "--max-old-space-size=8192"
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
# Upload entire repository
path: './docs'
- name: Deploy 🚀 to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2