Skip to content

Replace PaginatedMessages with HistoryPage #39

Replace PaginatedMessages with HistoryPage

Replace PaginatedMessages with HistoryPage #39

Workflow file for this run

name: API Reference
on:
pull_request:
paths:
- 'src/**'
- 'package.json'
- 'tsconfig*.json'
- 'typedoc.json'
push:
branches: [main]
tags:
- '*'
jobs:
build:
runs-on: ubuntu-latest
permissions:
deployments: write
id-token: write
contents: read
steps:
- uses: actions/checkout@v4
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@v4
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