docs-publish.yml

# Workflow that deploys project documentation to GitHub Pages
name: Build and Deploy Docs

on:
  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

  # Automatically triggers when a new release is published
  workflow_run:
    workflows: ["Release to NPM Registry"]
    types:
      - completed

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

    runs-on: ubuntu-latest

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

      # https://cashapp.github.io/hermit/usage/ci/
      - name: Init Hermit
        uses: cashapp/activate-hermit@v1
        with:
          cache: "true"

      - name: Install dependencies
        run: pnpm install --frozen-lockfile

      - name: Build all workspace packages
        run: pnpm --recursive --stream build

      - name: TBDocs Reporter
        id: tbdocs-reporter-protocol
        uses: TBD54566975/tbdocs@main
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          fail_on_error: true
          group_docs: true
          entry_points: |
            - file: packages/api/src/index.ts
              docsReporter: typedoc
              docsGenerator: typedoc-html
              readmeFile: packages/api/README.md
            - file: packages/crypto/src/index.ts
              docsReporter: typedoc
              docsGenerator: typedoc-html
              readmeFile: packages/crypto/README.md
            - file: packages/crypto-aws-kms/src/index.ts
              docsReporter: typedoc
              docsGenerator: typedoc-html
              readmeFile: packages/crypto-aws-kms/README.md
            - file: packages/dids/src/index.ts
              docsReporter: typedoc
              docsGenerator: typedoc-html
              readmeFile: packages/dids/README.md
            - file: packages/credentials/src/index.ts
              docsReporter: typedoc
              docsGenerator: typedoc-html
              readmeFile: packages/credentials/README.md

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

  deploy:
    # Add a dependency to the build job
    needs: build

    # 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@b8130d9ab958b325bbde9786d62f2c97a9885a0e #v3.0.7

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

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

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