Skip to content

docs: add comments to tsbuild.mjs #43

docs: add comments to tsbuild.mjs

docs: add comments to tsbuild.mjs #43

Workflow file for this run

name: "Publish Docs"
on:
push:
branches:
- main
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:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 18
- name: NPM Install
run: npm ci
- name: Compile TypeScript
run: npm run compile
- name: Build Docs
run: npm run docs
env:
NEXT_PUBLIC_BASE_PATH: /superdocs
- name: Upload Pages Artifact
uses: actions/upload-pages-artifact@v1
with:
path: packages/docs/out
deploy:
needs: build
runs-on: ubuntu-latest
# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2