ably-ai-transport-js/.github/workflows/docs.yml at c7dca80eddc250cc2b7dc8ac87d4abbe561c30a5 · ably/ably-ai-transport-js · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
name: API Reference

on:
  pull_request:
    paths:
      - 'src/**'
      - 'package.json'
      - 'tsconfig*.json'
      - 'typedoc.json'
  push:
    branches: [main]
    tags:
      - '*'

jobs:
  docs:
    runs-on: ubuntu-latest
    permissions:
      deployments: write
      id-token: write
      contents: read
    steps:
      - uses: actions/checkout@v6
        with:
          submodules: true
      - uses: actions/setup-node@v6
        with:
          node-version: 24
          cache: npm
      - run: npm ci
      - name: Build Documentation
        run: npm run docs
      # Only upload docs from the main repo (not forks or dependabot)
      - name: Configure AWS Credentials
        uses: aws-actions/configure-aws-credentials@v6
        if: >-
          github.repository == 'ably/ably-ai-transport-js' &&
          (github.event_name == 'push' || (github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository)) &&
          github.actor != 'dependabot[bot]'
        with:
          aws-region: eu-west-2
          role-to-assume: arn:aws:iam::${{ secrets.ABLY_AWS_ACCOUNT_ID_SDK }}:role/ably-sdk-builds-ably-ai-transport-js
          role-session-name: ${{ github.run_id }}-${{ github.run_number }}
      - name: Upload Documentation
        uses: ably/sdk-upload-action@v2
        if: >-
          github.repository == 'ably/ably-ai-transport-js' &&
          (github.event_name == 'push' || (github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository)) &&
          github.actor != 'dependabot[bot]'
        with:
          sourcePath: typedoc/generated
          githubToken: ${{ secrets.GITHUB_TOKEN }}
          artifactName: typedoc