Repository navigation
docs: rewrite documentation in plain English #191
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: | |
| pull_request: | |
| schedule: | |
| - cron: '17 4 1 * *' | |
| workflow_call: | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| concurrency: | |
| group: >- | |
| ci-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
| cancel-in-progress: ${{ github.event_name == 'pull_request' }} | |
| jobs: | |
| source-quality: | |
| name: Source quality | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 15 | |
| steps: | |
| - &checkout | |
| name: Check out repository | |
| uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | |
| with: | |
| fetch-depth: 0 | |
| persist-credentials: false | |
| - &setup_repository | |
| name: Set up repository | |
| uses: ./.github/actions/setup-repository | |
| - name: Verify formatting | |
| run: vp run format | |
| - name: Check shipped skills | |
| env: | |
| INTENT_REVIEW_BASE: ${{ github.event.pull_request.base.sha }} | |
| run: | | |
| vp run skills-check | |
| if [ -n "$INTENT_REVIEW_BASE" ]; then | |
| vp exec intent maintainer check --base "$INTENT_REVIEW_BASE" --github-summary | |
| else | |
| vp exec intent maintainer check --github-summary | |
| fi | |
| - name: Run type-aware linting and TypeScript checking | |
| run: vp run typecheck | |
| - name: Check public API compiler fixtures | |
| run: vp run api-types | |
| - name: Run Effect diagnostics | |
| run: vp run effect-check | |
| - name: Run Fallow audits | |
| run: vp run fallow | |
| - name: Run Vitest | |
| run: vp run test | |
| example-builds: | |
| name: Example builds | |
| needs: source-quality | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 15 | |
| steps: | |
| - *checkout | |
| - *setup_repository | |
| - name: Build Vite React application | |
| run: vp run vite-react-build | |
| - name: Build TanStack Start application | |
| run: vp run tanstack-start-build | |
| - name: Preserve application builds | |
| uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 | |
| with: | |
| name: application-builds | |
| path: | | |
| dist | |
| examples/vite-react/dist | |
| examples/tanstack-start/dist | |
| if-no-files-found: error | |
| include-hidden-files: true | |
| retention-days: 7 | |
| documentation: | |
| name: Documentation | |
| needs: source-quality | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 15 | |
| steps: | |
| - *checkout | |
| - *setup_repository | |
| - name: Check documentation | |
| run: vp run docs-check | |
| - name: Build documentation | |
| run: vp run docs-build | |
| - name: Preserve documentation build | |
| uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 | |
| with: | |
| name: documentation-build | |
| path: apps/docs/dist | |
| if-no-files-found: error | |
| include-hidden-files: true | |
| retention-days: 7 | |
| browser: | |
| name: Playwright (${{ matrix.browser }}) | |
| needs: | |
| - example-builds | |
| - documentation | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 20 | |
| strategy: | |
| fail-fast: true | |
| matrix: | |
| browser: | |
| - chromium | |
| - firefox | |
| - webkit | |
| steps: | |
| - *checkout | |
| - *setup_repository | |
| - name: Restore application builds | |
| uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 | |
| with: | |
| name: application-builds | |
| - name: Restore documentation build | |
| uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1 | |
| with: | |
| name: documentation-build | |
| path: apps/docs/dist | |
| - name: Install ${{ matrix.browser }} | |
| run: vp exec playwright install --with-deps ${{ matrix.browser }} | |
| - name: Check documentation in ${{ matrix.browser }} | |
| run: vp run --ignore-depends-on docs-e2e --project=${{ matrix.browser }} | |
| - name: Run ${{ matrix.browser }} acceptance tests | |
| run: vp run --ignore-depends-on e2e:${{ matrix.browser }} | |
| - name: Preserve Playwright failure diagnostics | |
| if: failure() | |
| uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 | |
| with: | |
| name: playwright-${{ matrix.browser }}-${{ github.sha }} | |
| path: test-results | |
| if-no-files-found: ignore | |
| retention-days: 7 |