GitHub Action to automatically deploy moonwave docs to GitHub Pages

docs.yml

# .github/workflows/docs.yml

name: Deploy documentation to GitHub Pages

on:
  push:
    branches:
      - main
    paths:
      - 'src/**'
      - 'docs/**'
      - 'moonwave.toml'

permissions:
  contents: write
  pages: write
  id-token: write

# Prevent concurrent runs
concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:
  deploy-docs:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    runs-on: ubuntu-24.04

    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Setup node
        uses: actions/setup-node@v4
        with:
          node-version: 20

      - name: Install dependencies
        run: npm install

      - name: Build documentation
        run: npm run build:docs

      - name: Setup Pages
        uses: actions/configure-pages@v5

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: './build'

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4

package.json

{
  "name": "repository",
  "version": "1.0.0",
  "dependencies": {
    "moonwave": "^1.1.2"
  }
}