Skip to content

Remove outdated documentation files and enhance project structure. De… #1

Remove outdated documentation files and enhance project structure. De…

Remove outdated documentation files and enhance project structure. De… #1

Workflow file for this run

# GitHub Actions workflow for auto-deploying documentation
#
# To enable: Enable GitHub Pages in repository settings:
# Settings → Pages → Source: GitHub Actions
#
# This workflow will:
# 1. Run on every push to main branch
# 2. Generate documentation using TypeDoc
# 3. Deploy to GitHub Pages automatically
name: Deploy Documentation
on:
push:
branches: [main]
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: "20"
cache: "npm"
- name: Install dependencies
run: npm ci
- name: Run checks
run: npm run check
- name: Run tests
run: npm test
- name: Generate documentation
run: npm run docs
- name: Setup Pages
uses: actions/configure-pages@v4
- 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