docs.yml

name: API Reference
on:
  pull_request:
  push:
    branches:
      - main
    tags:
      - '*'

jobs:
  build:
    if: github.actor != 'dependabot[bot]' || github.event_name != 'pull_request'
    runs-on: ubuntu-latest
    permissions:
      deployments: write
      id-token: write
      contents: read
    steps:
      - uses: actions/checkout@v3
        with:
          submodules: true

      - name: Use Node.js 20.x
        uses: actions/setup-node@v3
        with:
          node-version: 20.x

      - name: Install Package Dependencies
        run: npm ci

      - name: Build Documentation
        run: npm run docs

      - name: Configure AWS Credentials
        uses: aws-actions/configure-aws-credentials@v1
        with:
          aws-region: eu-west-2
          role-to-assume: arn:aws:iam::${{ secrets.ABLY_AWS_ACCOUNT_ID_SDK }}:role/ably-sdk-builds-ably-chat-js
          role-session-name: "${{ github.run_id }}-${{ github.run_number }}"

      - name: Upload Documentation
        uses: ably/sdk-upload-action@v2
        with:
          sourcePath: typedoc/generated
          githubToken: ${{ secrets.GITHUB_TOKEN }}
          artifactName: typedoc