Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

next
yml 60 lines 1.87 KB
Raw
1 name: Docs - Lint and TypeScript Validation
2
3 on:
4 pull_request:
5 paths:
6 - 'docs/**'
7 - '.github/actions/setup-node-pnpm-bun/action.yml'
8 - '.github/workflows/docs-typescript-check.yml'
9 - 'mise.toml'
10 - 'mise.lock'
11
12 concurrency:
13 group: ${{ github.workflow }}-${{ github.event_name == 'pull_request' && github.ref || github.run_id }}
14 cancel-in-progress: ${{ github.event_name == 'pull_request' }}
15
16 permissions:
17 contents: read
18
19 jobs:
20 typescript-check:
21 # This job installs the published SDK packages. A release PR checks its docs against the
22 # packages it will publish instead, in the `SDK candidate docs` check.
23 if: ${{ !startsWith(github.head_ref, 'sdk-release/batch-') }}
24 runs-on: ubuntu-latest
25 defaults:
26 run:
27 working-directory: ./docs
28
29 steps:
30 - name: Checkout repository
31 uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
32
33 - name: Setup Node.js, pnpm, Bun
34 uses: ./.github/actions/setup-node-pnpm-bun
35
36 - name: Cache bun dependencies
37 uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
38 with:
39 path: ~/.bun/install/cache
40 key: ${{ runner.os }}-bun-${{ hashFiles('docs/bun.lock') }}
41 restore-keys: |
42 ${{ runner.os }}-bun-
43
44 - name: Install dependencies
45 run: bun install --frozen-lockfile
46
47 - name: Lint TypeScript
48 run: bun run lint
49
50 - name: TypeScript type check
51 run: bun run types:check
52
53 - name: Check TypeScript snippet and KB language-option regressions
54 run: bun test tests/static/typescript-snippets.test.ts tests/static/kb-generation.test.ts
55
56 - name: Check authored TypeScript outside Twoslash build coverage
57 run: bun run check:typescript-snippets
58
59 - name: Build (validates Twoslash TypeScript code blocks)
60 run: bun run build