docs: rewrite README for clarity and structure #912
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 | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| branches: [main] | |
| workflow_dispatch: | |
| # Cancel in-flight runs for the same ref when a newer commit lands. | |
| # Saves CI minutes on rapid push sessions. Intentionally NOT applied | |
| # to publish.yml — never cancel an in-progress npm publish. | |
| concurrency: | |
| group: ci-${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| build-and-test: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| node-version: [20, 22, 24] | |
| steps: | |
| - uses: actions/checkout@v6 | |
| - name: Install pnpm | |
| uses: pnpm/action-setup@v6 | |
| with: | |
| version: 9.15.4 | |
| - name: Use Node.js ${{ matrix.node-version }} | |
| uses: actions/setup-node@v6 | |
| with: | |
| node-version: ${{ matrix.node-version }} | |
| cache: pnpm | |
| - name: Install dependencies | |
| run: pnpm install --frozen-lockfile | |
| - name: Build | |
| run: pnpm build | |
| - name: Test | |
| run: pnpm test | |
| env: | |
| CI: true | |
| quality: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v6 | |
| - name: Install pnpm | |
| uses: pnpm/action-setup@v6 | |
| with: | |
| version: 9.15.4 | |
| - name: Use Node.js | |
| uses: actions/setup-node@v6 | |
| with: | |
| node-version: 22 | |
| cache: pnpm | |
| - name: Install dependencies | |
| run: pnpm install --frozen-lockfile | |
| - name: Build | |
| run: pnpm build | |
| - name: Type check | |
| run: pnpm typecheck | |
| # Lint is platform-independent; running it across the Node matrix | |
| # was 3x duplicated work without value. Single run here. | |
| - name: Lint | |
| run: pnpm lint | |
| - name: CLI reference is generated | |
| run: pnpm gen:reference:check | |
| - name: Agent host configs are generated | |
| run: pnpm agent-sync:check | |
| - name: Package smoke | |
| run: pnpm package:check | |
| - name: Dogfood smoke | |
| run: pnpm test:dogfood |