Add internal JSDocs throughout the codebase #4564
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: CI Checks | |
| on: | |
| pull_request: | |
| branches: | |
| - main | |
| merge_group: | |
| types: [checks_requested] | |
| workflow_dispatch: | |
| concurrency: ${{ github.workflow }}-${{ github.ref }} | |
| jobs: | |
| ci-checks: | |
| name: CI Checks | |
| strategy: | |
| matrix: | |
| os: [windows-latest, ubuntu-latest] | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - name: Debug | |
| run: echo "${{ matrix.os }}" | |
| - name: Check Out Repo | |
| uses: actions/checkout@v6 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-node@v6 | |
| with: | |
| node-version: lts/* | |
| cache: yarn | |
| id: setup-node | |
| - name: Get Node Version | |
| run: echo "version=$(node -v)" >> $GITHUB_OUTPUT | |
| id: node-version | |
| - name: Cache node_modules | |
| uses: actions/cache@v5 | |
| with: | |
| path: node_modules | |
| key: ${{ runner.os }}-${{ steps.node-version.outputs.version }}-${{ hashFiles('**/yarn.lock') }} | |
| - name: Install Packages | |
| run: yarn install --frozen-lockfile --network-timeout 100000 | |
| - name: Patch packages | |
| run: yarn patch-package | |
| - name: ESlint | |
| if: matrix.os != 'windows-latest' | |
| run: yarn eslint -f github-annotations . | |
| - name: TypeScript | |
| if: matrix.os != 'windows-latest' | |
| run: yarn tsc --noEmit | |
| - name: Unit Tests | |
| timeout-minutes: 2 | |
| run: yarn test --runInBand --forceExit --verbose --no-watchman | |
| - name: Set up Python | |
| uses: actions/setup-python@v6 | |
| with: | |
| python-version: "3.x" | |
| - name: Install Python dependencies | |
| run: pip install -r test-black-box/requirements.txt | |
| - name: Black Box Tests | |
| timeout-minutes: 5 | |
| run: yarn test:black-box | |
| - name: Type Tests | |
| timeout-minutes: 2 | |
| run: yarn build && yarn test:tsd |