chore: simplify readme and link to other sections (#566) #1116
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] | |
| types: [opened, synchronize, reopened, labeled, unlabeled] | |
| permissions: | |
| contents: read | |
| concurrency: | |
| group: ci-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} | |
| cancel-in-progress: true | |
| env: | |
| GO_VERSION: "1.25" | |
| GOPLS_VERSION: "v0.21.1" | |
| CLANGD_VERSION: "18" | |
| NODE_VERSION: "24" | |
| PNPM_VERSION: "11" | |
| TYPESCRIPT_VERSION: "5.9.3" | |
| TYPESCRIPT_LANGUAGE_SERVER_VERSION: "6.0.0" | |
| jobs: | |
| classify: | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 5 | |
| outputs: | |
| runtime: ${{ steps.changes.outputs.runtime }} | |
| docs_web: ${{ steps.changes.outputs.docs_web }} | |
| reason: ${{ steps.changes.outputs.reason }} | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v7 | |
| with: | |
| fetch-depth: 0 | |
| - name: Classify changes | |
| id: changes | |
| env: | |
| EVENT_NAME: ${{ github.event_name }} | |
| BASE_SHA: ${{ github.event.pull_request.base.sha }} | |
| HEAD_SHA: ${{ github.event.pull_request.head.sha }} | |
| FORCE_FULL: ${{ contains(github.event.pull_request.labels.*.name, 'ci:full') }} | |
| run: | | |
| set -euo pipefail | |
| changed_files=$(mktemp) | |
| runtime=false | |
| docs_web=false | |
| reason="documentation-only pull request" | |
| if [[ "$EVENT_NAME" != "pull_request" ]]; then | |
| git show --format= --no-renames --name-only -z HEAD > "$changed_files" | |
| runtime=true | |
| docs_web=true | |
| reason="pushes to main run the full contract" | |
| else | |
| git diff --no-renames --name-only -z --diff-filter=ACMRD "$BASE_SHA...$HEAD_SHA" > "$changed_files" | |
| if [[ "$FORCE_FULL" == "true" ]]; then | |
| runtime=true | |
| docs_web=true | |
| reason="ci:full requests every lane" | |
| elif [[ ! -s "$changed_files" ]]; then | |
| runtime=true | |
| reason="no changed files were detected, so CI failed closed" | |
| else | |
| while IFS= read -r -d '' path; do | |
| case "$path" in | |
| docs-web/*) | |
| docs_web=true | |
| ;; | |
| README.md|AGENTS.md|ARCHITECTURE.md|LICENSE|audit/*.md|workflows/*.md) | |
| ;; | |
| *) | |
| runtime=true | |
| ;; | |
| esac | |
| done < "$changed_files" | |
| if [[ "$runtime" == "true" ]]; then | |
| reason="at least one changed file can affect the runtime or its tests" | |
| fi | |
| fi | |
| fi | |
| { | |
| echo "runtime=$runtime" | |
| echo "docs_web=$docs_web" | |
| echo "reason=$reason" | |
| } >> "$GITHUB_OUTPUT" | |
| { | |
| echo "## CI classification" | |
| echo | |
| echo "| Lane | Selected | Contract |" | |
| echo "| --- | --- | --- |" | |
| echo "| classify | true | blocking |" | |
| echo "| vet, lint, test | $runtime | blocking |" | |
| echo "| docs | $docs_web | blocking when selected |" | |
| echo "| test-race | $runtime | blocking when selected |" | |
| echo "| functional-tests | $runtime | blocking when selected |" | |
| echo "| integration-tests | $runtime | blocking when selected |" | |
| echo "| lsp-tests | $runtime | blocking when selected |" | |
| echo "| fast-contract, ci-contract | true | blocking |" | |
| echo | |
| echo "Reason: $reason." | |
| echo | |
| echo "### Changed files" | |
| echo | |
| while IFS= read -r -d '' path; do | |
| printf -- '- `%q`\n' "$path" | |
| done < "$changed_files" | |
| } >> "$GITHUB_STEP_SUMMARY" | |
| vet: | |
| needs: classify | |
| if: needs.classify.outputs.runtime == 'true' | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 10 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v7 | |
| - name: Set up Go | |
| uses: actions/setup-go@v7 | |
| with: | |
| go-version: ${{ env.GO_VERSION }} | |
| - name: Vet | |
| run: go vet ./... | |
| lint: | |
| needs: classify | |
| if: needs.classify.outputs.runtime == 'true' | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 10 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v7 | |
| - name: Set up Go | |
| uses: actions/setup-go@v7 | |
| with: | |
| go-version: ${{ env.GO_VERSION }} | |
| - name: golangci-lint | |
| uses: golangci/golangci-lint-action@v9 | |
| with: | |
| version: latest | |
| test: | |
| needs: classify | |
| if: needs.classify.outputs.runtime == 'true' | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 15 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v7 | |
| - name: Set up Go | |
| uses: actions/setup-go@v7 | |
| with: | |
| go-version: ${{ env.GO_VERSION }} | |
| - name: Download modules | |
| run: go mod download | |
| - name: Build | |
| run: go build ./... | |
| - name: Test | |
| run: go test ./... | |
| docs: | |
| needs: classify | |
| if: needs.classify.outputs.docs_web == 'true' | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 15 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v7 | |
| - uses: pnpm/action-setup@v6 | |
| with: | |
| version: ${{ env.PNPM_VERSION }} | |
| - uses: actions/setup-node@v7 | |
| with: | |
| node-version: ${{ env.NODE_VERSION }} | |
| cache: pnpm | |
| cache-dependency-path: docs-web/pnpm-lock.yaml | |
| - name: Install docs dependencies | |
| working-directory: docs-web | |
| run: pnpm install --frozen-lockfile | |
| - name: Build docs | |
| working-directory: docs-web | |
| run: pnpm build | |
| test-race: | |
| needs: classify | |
| if: needs.classify.outputs.runtime == 'true' | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 15 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v7 | |
| - name: Set up Go | |
| uses: actions/setup-go@v7 | |
| with: | |
| go-version: ${{ env.GO_VERSION }} | |
| - name: Download modules | |
| run: go mod download | |
| - name: Test with race detector | |
| run: go test -race ./... | |
| functional-tests: | |
| needs: classify | |
| if: needs.classify.outputs.runtime == 'true' | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 10 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v7 | |
| - name: Set up Go | |
| uses: actions/setup-go@v7 | |
| with: | |
| go-version: ${{ env.GO_VERSION }} | |
| - name: Build binary | |
| run: make build | |
| - uses: pnpm/action-setup@v6 | |
| with: | |
| version: ${{ env.PNPM_VERSION }} | |
| - uses: actions/setup-node@v7 | |
| with: | |
| node-version: ${{ env.NODE_VERSION }} | |
| cache: pnpm | |
| cache-dependency-path: tests/functional/pnpm-lock.yaml | |
| - name: Install test dependencies | |
| working-directory: tests/functional | |
| run: pnpm install --frozen-lockfile | |
| - name: Run functional tests | |
| working-directory: tests/functional | |
| run: pnpm exec vitest run --reporter=verbose | |
| integration-tests: | |
| needs: classify | |
| if: needs.classify.outputs.runtime == 'true' | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 10 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v7 | |
| - name: Set up Go | |
| uses: actions/setup-go@v7 | |
| with: | |
| go-version: ${{ env.GO_VERSION }} | |
| - name: Build binary | |
| run: make build | |
| - uses: pnpm/action-setup@v6 | |
| with: | |
| version: ${{ env.PNPM_VERSION }} | |
| - uses: actions/setup-node@v7 | |
| with: | |
| node-version: ${{ env.NODE_VERSION }} | |
| cache: pnpm | |
| cache-dependency-path: tests/integration/pnpm-lock.yaml | |
| - name: Install test dependencies | |
| working-directory: tests/integration | |
| run: pnpm install --frozen-lockfile | |
| - name: Run integration tests | |
| working-directory: tests/integration | |
| run: pnpm exec vitest run --reporter=verbose --exclude='**/lsp*.test.js' | |
| lsp-tests: | |
| needs: classify | |
| if: needs.classify.outputs.runtime == 'true' | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 15 | |
| outputs: | |
| test_outcome: ${{ steps.lsp.outcome }} | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v7 | |
| - name: Set up Go | |
| uses: actions/setup-go@v7 | |
| with: | |
| go-version: ${{ env.GO_VERSION }} | |
| - name: Build binary | |
| run: make build | |
| - uses: pnpm/action-setup@v6 | |
| with: | |
| version: ${{ env.PNPM_VERSION }} | |
| - uses: actions/setup-node@v7 | |
| with: | |
| node-version: ${{ env.NODE_VERSION }} | |
| cache: pnpm | |
| cache-dependency-path: tests/integration/pnpm-lock.yaml | |
| - name: Install LSP servers | |
| run: | | |
| go install "golang.org/x/tools/gopls@${GOPLS_VERSION}" | |
| npm install -g "typescript@${TYPESCRIPT_VERSION}" "typescript-language-server@${TYPESCRIPT_LANGUAGE_SERVER_VERSION}" | |
| sudo apt-get update | |
| sudo apt-get install -y "clangd-${CLANGD_VERSION}" | |
| sudo ln -sf "/usr/bin/clangd-${CLANGD_VERSION}" /usr/local/bin/clangd | |
| - name: Provide typescript to the TS fixture workspace | |
| run: npm install --prefix tests/integration/lsp/typescript --no-save "typescript@${TYPESCRIPT_VERSION}" | |
| - name: Install test dependencies | |
| working-directory: tests/integration | |
| run: pnpm install --frozen-lockfile | |
| - name: Run LSP tests | |
| id: lsp | |
| working-directory: tests/integration | |
| run: pnpm exec vitest run --reporter=verbose lsp-compatibility.test.js | |
| fast-contract: | |
| needs: [classify, vet, lint, test, docs] | |
| if: ${{ always() && !cancelled() }} | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 5 | |
| env: | |
| CLASSIFY_RESULT: ${{ needs.classify.result }} | |
| RUNTIME: ${{ needs.classify.outputs.runtime }} | |
| DOCS_WEB: ${{ needs.classify.outputs.docs_web }} | |
| VET_RESULT: ${{ needs.vet.result }} | |
| LINT_RESULT: ${{ needs.lint.result }} | |
| TEST_RESULT: ${{ needs.test.result }} | |
| DOCS_RESULT: ${{ needs.docs.result }} | |
| steps: | |
| - name: Verify fast contract | |
| run: | | |
| set -euo pipefail | |
| failed=false | |
| require_result() { | |
| local name=$1 | |
| local selected=$2 | |
| local result=$3 | |
| local expected=skipped | |
| if [[ "$selected" == "true" ]]; then | |
| expected=success | |
| fi | |
| if [[ "$result" != "$expected" ]]; then | |
| echo "::error::$name finished as $result; expected $expected" | |
| failed=true | |
| fi | |
| } | |
| if [[ "$CLASSIFY_RESULT" != "success" ]]; then | |
| echo "::error::classify finished as $CLASSIFY_RESULT" | |
| failed=true | |
| fi | |
| require_result vet "$RUNTIME" "$VET_RESULT" | |
| require_result lint "$RUNTIME" "$LINT_RESULT" | |
| require_result test "$RUNTIME" "$TEST_RESULT" | |
| require_result docs "$DOCS_WEB" "$DOCS_RESULT" | |
| { | |
| echo "## Fast contract" | |
| echo | |
| echo "| Lane | Result |" | |
| echo "| --- | --- |" | |
| echo "| classify | $CLASSIFY_RESULT |" | |
| echo "| vet | $VET_RESULT |" | |
| echo "| lint | $LINT_RESULT |" | |
| echo "| test | $TEST_RESULT |" | |
| echo "| docs | $DOCS_RESULT |" | |
| echo | |
| echo "This contract proves classification plus the selected deterministic build, test, lint, and docs checks. It does not replace the broad binary, PTY, race, or real-LSP lanes." | |
| } >> "$GITHUB_STEP_SUMMARY" | |
| [[ "$failed" == "false" ]] | |
| ci-contract: | |
| needs: [classify, fast-contract, test-race, functional-tests, integration-tests, lsp-tests] | |
| if: ${{ always() && !cancelled() }} | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 5 | |
| env: | |
| CLASSIFY_RESULT: ${{ needs.classify.result }} | |
| RUNTIME: ${{ needs.classify.outputs.runtime }} | |
| FAST_RESULT: ${{ needs.fast-contract.result }} | |
| RACE_RESULT: ${{ needs.test-race.result }} | |
| FUNCTIONAL_RESULT: ${{ needs.functional-tests.result }} | |
| INTEGRATION_RESULT: ${{ needs.integration-tests.result }} | |
| LSP_RESULT: ${{ needs.lsp-tests.result }} | |
| LSP_TEST_OUTCOME: ${{ needs.lsp-tests.outputs.test_outcome || 'not-run' }} | |
| steps: | |
| - name: Verify selected CI lanes | |
| run: | | |
| set -euo pipefail | |
| failed=false | |
| require_result() { | |
| local name=$1 | |
| local selected=$2 | |
| local result=$3 | |
| local expected=skipped | |
| if [[ "$selected" == "true" ]]; then | |
| expected=success | |
| fi | |
| if [[ "$result" != "$expected" ]]; then | |
| echo "::error::$name finished as $result; expected $expected" | |
| failed=true | |
| fi | |
| } | |
| if [[ "$CLASSIFY_RESULT" != "success" ]]; then | |
| echo "::error::classify finished as $CLASSIFY_RESULT" | |
| failed=true | |
| fi | |
| if [[ "$FAST_RESULT" != "success" ]]; then | |
| echo "::error::fast-contract finished as $FAST_RESULT" | |
| failed=true | |
| fi | |
| require_result test-race "$RUNTIME" "$RACE_RESULT" | |
| require_result functional-tests "$RUNTIME" "$FUNCTIONAL_RESULT" | |
| require_result integration-tests "$RUNTIME" "$INTEGRATION_RESULT" | |
| require_result lsp-tests "$RUNTIME" "$LSP_RESULT" | |
| { | |
| echo "## CI contract" | |
| echo | |
| echo "| Lane | Result | Blocking |" | |
| echo "| --- | --- | --- |" | |
| echo "| fast-contract | $FAST_RESULT | yes |" | |
| echo "| test-race | $RACE_RESULT | yes when selected |" | |
| echo "| functional-tests | $FUNCTIONAL_RESULT | yes when selected |" | |
| echo "| integration-tests | $INTEGRATION_RESULT | yes when selected |" | |
| echo "| lsp-tests | $LSP_RESULT ($LSP_TEST_OUTCOME) | yes when selected |" | |
| echo | |
| echo "The pinned real-LSP lane proves known C, Go, and TypeScript server compatibility. The scheduled canary owns latest-version ecosystem drift." | |
| } >> "$GITHUB_STEP_SUMMARY" | |
| [[ "$failed" == "false" ]] |