onnxruntime

1
name: Update JS API Docs
2

3
# Run when the JS API changes or every month so that the artifact does not expire
4
on:
5
  push:
6
    branches:
7
      - main
8
    paths:
9
      - js/common/**
10
  schedule:
11
    - cron: '0 0 1 * *'
12
  workflow_dispatch:
13

14
concurrency:
15
  group: "apidocs-js"
16
  cancel-in-progress: false
17

18
permissions:
19
  contents: write
20

21
jobs:
22
  build:
23
    name: Generate JS API docs
24
    runs-on: ubuntu-latest
25
    steps:
26
      - uses: actions/checkout@v4
27
      - name: Setup Node.js
28
        uses: actions/setup-node@v4
29
        with:
30
          node-version: 18
31
      - name: Generate JS docs 
32
        run: |
33
          cd js/
34
          npm ci
35
          cd common/
36
          npm ci
37
          npx typedoc
38
      - name: Log source commit
39
        run: git rev-parse --short HEAD > js/common/docs/source-version.txt
40
      - name: Move JS docs into site
41
        run: |
42
          rm -rf _site/docs/api/js
43
          mkdir -p _site/docs/api
44
          mv js/common/docs _site/docs/api/js
45
      - name: Upload docs artifact
46
        uses: actions/upload-artifact@v4
47
        with:
48
          name: onnxruntime-node-apidocs
49
          path: _site
50
          retention-days: 60
51