docs: rewrite README around current install and integration surface #142
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: pr-fast | |
| on: | |
| workflow_dispatch: | |
| pull_request: | |
| paths-ignore: | |
| - "LICENSE" | |
| permissions: | |
| contents: read | |
| concurrency: | |
| group: pr-fast-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| lint-fast: | |
| name: pr-fast-lint | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-go@v5 | |
| with: | |
| go-version-file: go.mod | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.11" | |
| - name: Install uv | |
| run: | | |
| python -m pip install --upgrade pip uv | |
| - name: Configure repo hooks path | |
| run: | | |
| git config core.hooksPath .githooks | |
| - name: Lint (fast) | |
| run: | | |
| make lint-fast | |
| test-fast: | |
| name: pr-fast-test | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-go@v5 | |
| with: | |
| go-version-file: go.mod | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.11" | |
| - name: Install uv | |
| run: | | |
| python -m pip install --upgrade pip uv | |
| - name: Unit tests (fast) | |
| env: | |
| PYTHONPATH: . | |
| run: | | |
| make test-fast | |
| - name: CLI contract tests | |
| run: | | |
| go test ./cmd/gait -count=1 | |
| - name: Claude Code hook contract | |
| run: | | |
| bash scripts/test_claude_code_hook_contract.sh | |
| - name: Validate scenario fixtures | |
| run: | | |
| bash scripts/validate_scenarios.sh | |
| repro-guards: | |
| name: pr-fast-repro-guards-py${{ matrix.python-version }} | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ["3.11", "3.13"] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-go@v5 | |
| with: | |
| go-version-file: go.mod | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install uv | |
| run: | | |
| python -m pip install --upgrade pip uv | |
| - name: Run boundary contract repro guards | |
| env: | |
| PYTHONPATH: . | |
| shell: bash | |
| run: | | |
| go test ./cmd/gait -count=1 -run 'TestRunGateEvalRequiresVerifiedContextEnvelopeForContextPolicies|TestPolicyTestEqualPriorityRenamesDoNotChangeVerdict' | |
| go test ./core/gate -count=1 -run 'TestEvaluatePolicyDetailedEqualPriorityRenameDoesNotChangeVerdict' | |
| go test ./core/jobruntime -count=1 -run 'TestSubmitAppendFailureRollsBackNewJob|TestMutationAppendFailureRollsBackStateAndRetrySucceeds|TestMutationAppendFailureWithDurableEventPreservesPendingMarker' | |
| cd sdk/python | |
| uv run --python ${{ matrix.python-version }} --extra dev pytest tests/test_client.py -q -k 'capture_demo_runpack_uses_json_cli_contract or capture_demo_runpack_malformed_json_raises_command_error' | |
| windows-fast: | |
| name: pr-fast-windows | |
| runs-on: windows-latest | |
| timeout-minutes: 20 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-go@v5 | |
| with: | |
| go-version-file: go.mod | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.11" | |
| - name: Install uv | |
| shell: bash | |
| run: | | |
| python -m pip install --upgrade pip uv | |
| - name: Windows Go smoke suite | |
| shell: bash | |
| run: | | |
| go test -json ./... | |
| go build ./cmd/gait | |
| - name: Windows Python SDK repro guard | |
| shell: bash | |
| env: | |
| PYTHONPATH: . | |
| run: | | |
| cd sdk/python | |
| uv run --python 3.11 --extra dev pytest tests/test_client.py -q -k 'capture_demo_runpack_uses_json_cli_contract or capture_demo_runpack_malformed_json_raises_command_error' |