docs-ci.yml

name: Docs Continuous Integration

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

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

jobs:
  tbdocs-reporter:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout source
        uses: actions/checkout@v4

      - name: Set up Node.js
        uses: actions/setup-node@v4
        with:
          node-version: 18
          registry-url: https://registry.npmjs.org/
          cache: 'npm'

      - name: Install dependencies
        run: npm ci

      - name: Build all workspace packages
        run: npm run build

      - name: TBDocs Reporter
        id: tbdocs-reporter-protocol
        uses: TBD54566975/tbdocs@main
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          report_changed_scope_only: false
          fail_on_error: false
          entry_points: |
            - file: packages/api/src/index.ts
              docsReporter: api-extractor
              docsGenerator: typedoc-markdown

      - name: Save Artifacts
        uses: actions/upload-artifact@v3
        if: always()
        with:
          name: tbdocs-reporter-output
          path: ./.tbdocs