This repository has been archived by the owner on Feb 2, 2024. It is now read-only.
🔖 version bump to v10.1.16. #1
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Document | |
on: | |
push: | |
branches: | |
- main | |
jobs: | |
build: | |
name: Build documentation | |
runs-on: ubuntu-latest | |
steps: | |
- name: Use Checkout 4 | |
uses: actions/checkout@v4 | |
- name: Use Node.js 20 | |
uses: actions/setup-node@v3 | |
with: | |
node-version: 20 | |
- name: Use pnpm 8 | |
uses: pnpm/action-setup@v2 | |
with: | |
version: 8 | |
run_install: true | |
- name: Install typedoc | |
run: pnpm add -g typedoc | |
- name: Generate documentation | |
run: typedoc | |
- name: Copy documentation assets | |
run: cp ./favicon.ico ./logo.svg ./docs | |
- name: Upload pages artifact | |
uses: actions/upload-pages-artifact@v1 | |
with: | |
path: ./docs | |
name: github-pages | |
retention-days: 1 | |
deploy: | |
name: Deploy documentation | |
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@v1 |