docs-publish.yml

# Workflow that deploys project documentation to GitHub Pages
name: Publish Docs to GH Pages

on:
  # Manual trigger
  workflow_dispatch:
  # Call from the release workflow
  workflow_call:

# 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-docs:
    permissions:
      contents: write # to write documentation files to the repo

    runs-on: ubuntu-latest

    steps:
      - name: Checkout source
        uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3.5.2
        with:
          submodules: "true"

      - name: install pnpm
        uses: pnpm/action-setup@v2
        with:
          version: 8

      - name: Set up Node.js
        uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0
        with:
          node-version: 20
          registry-url: https://registry.npmjs.org/

      - name: Install dependencies
        run: pnpm install

      - name: Build all workspace packages
        run: pnpm build

      - name: TBDocs Reporter
        id: tbdocs-reporter-protocol
        uses: TBD54566975/tbdocs@main
        with:
          group_docs: true
          fail_on_warnings: true
          fail_on_error: true
          entry_points: |
            - file: packages/protocol/src/main.ts
              docsReporter: api-extractor
              docsGenerator: typedoc-html
            - file: packages/http-client/src/main.ts
              docsReporter: api-extractor
              docsGenerator: typedoc-html
            - file: packages/http-server/src/main.ts
              docsReporter: api-extractor
              docsGenerator: typedoc-html

      - name: Upload documentation artifacts
        uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 #v3.1.3
        with:
          name: tbdocs-output
          path: ./.tbdocs

  deploy-gh-pages:
    # Add a dependency to the build job
    needs: build-docs

    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
    permissions:
      contents: read # to read from project repo
      pages: write # to deploy to Pages
      id-token: write # to verify the deployment originates from an appropriate source

    # Deploy to the github-pages environment
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 #v4.1.1

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

      - name: Download TBDocs Artifacts
        uses: actions/download-artifact@v3
        with:
          name: tbdocs-output
          path: ./tbdocs

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v1
        with:
          path: "./tbdocs/docs"

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