Skip to content

chore: implement typings in ending module (#280) #27

chore: implement typings in ending module (#280)

chore: implement typings in ending module (#280) #27

name: Publish Documentation
on:
push:
branches:
- 'main'
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
jobs:
build:
name: Build docs
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: "20"
cache: "npm"
- name: Install dependencies
run: |
npm set registry https://registry.npmjs.org/
npm ci
- name: Build documentation
run: npx typedoc src/index.ts
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./docs
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4