apunkt/omnigraph
1
0
Fork 0
mirror of https://github.com/ModernRelay/omnigraph.git synced 2026-06-15 01:55:13 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
omnigraph/docs/dev/ci.md
Andrew Altshuler 81b66f9427
ci: run Test Workspace only on main, not on pull requests (#212) 
The full workspace + failpoints suite was the slowest PR gate (~15min
warm, up to the 75min cold ceiling) and dominated PR turnaround. Gate the
`test` job with `if: github.event_name != 'pull_request'` so it runs only
on push to `main` (post-merge), on `v*` tags, and on manual
`workflow_dispatch`. `RustFS S3 Integration` needs `test`, so it becomes
push-/dispatch-only by the same cascade.

Drop `Test Workspace` from the required-check list in
branch-protection.json: a required context that never reports on PRs (the
job no longer runs there) would leave every PR permanently pending — the
job-never-reports trap the policy already documents.

Trade-off accepted deliberately (chosen by the maintainer): a regression
the suite would catch now lands on `main` and reddens the post-merge run
instead of being blocked pre-merge, so `main` can briefly break. Mitigations
documented in ci.md: run `cargo test --workspace --locked` locally before
merging non-trivial changes (or trigger the workflow on your branch via
workflow_dispatch), and regenerate openapi.json locally for server/API
changes (the auto-regen step lived in the now-PR-skipped test job).

The fast PR gates remain: Classify Changes, Check AGENTS.md Links, the
AWS-feature build/test, and the two CODEOWNERS checks.

NOTE: an admin must run ./scripts/apply-branch-protection.sh after this
merges, or GitHub keeps requiring the now-unreported Test Workspace context.

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-13 19:23:41 +03:00

3.2 KiB
Raw Blame History

CI / Release Workflows

.github/workflows/:

  • ci.yml: text-only changes skip; otherwise cargo test --workspace --locked on ubuntu-latest with protobuf compiler. OpenAPI-drift check that auto-commits the regenerated openapi.json for same-repository PRs. Also runs the AGENTS.md cross-link integrity check (scripts/check-agents-md.sh).
    • Test Workspace does not run on pull requests. The job is gated if: github.event_name != 'pull_request', so the full workspace + failpoints suite runs only on push to main (post-merge), on v* tags, and on manual workflow_dispatch. This was a deliberate PR-latency trade-off — it was the slowest gate (~15min warm, up to the 75min cold ceiling). RustFS S3 Integration needs: test, so it is push-/dispatch-only for the same reason. The fast PR gates remain: Classify Changes, Check AGENTS.md Links, Test omnigraph-server --features aws, and the two CODEOWNERS checks. Test Workspace is correspondingly not in the required-check list (.github/branch-protection.json); see branch-protection.md.
    • Consequences to internalize: (1) a regression that the suite would catch now lands on main and turns the post-merge run red, rather than being blocked pre-merge — main can briefly break, so run cargo test --workspace --locked locally before merging anything non-trivial, or trigger this workflow on your branch via the Actions "Run workflow" button. (2) openapi.json is no longer auto-regenerated on PRs (that step is inside the test job); for server/API changes, regenerate it locally with OMNIGRAPH_UPDATE_OPENAPI=1 cargo test -p omnigraph-server --test openapi and commit it, or the strict drift check fails the post-merge main run.
    • Applying this policy: removing Test Workspace from the JSON is inert until an admin runs ./scripts/apply-branch-protection.sh. Run it immediately after this change merges — until then GitHub still requires a Test Workspace context that no longer reports on PRs, which leaves every open PR permanently pending (the job-never-reports trap).
  • AWS feature build job: cargo build/test -p omnigraph-server --features aws on ubuntu-latest.
  • Windows binary build job: cargo build --release --locked -p omnigraph-cli -p omnigraph-server on windows-latest with smoke checks for omnigraph.exe version, omnigraph-server.exe --help, and PowerShell installer syntax.
  • RustFS S3 integration: spins up RustFS in Docker, runs s3_storage, server_opens_s3_graph_directly_and_serves_snapshot_and_read, and local_cli_s3_end_to_end_init_load_read_flow.
  • release-edge.yml: on every push to main, retags edge, builds Linux x86_64 / macOS arm64 archives and Windows x86_64 zip + sha256, publishes a rolling prerelease, then smoke-tests the Windows PowerShell installer against edge.
  • release.yml: on v* tags, builds the Linux x86_64 / macOS arm64 archives and Windows x86_64 zip release matrix, updates the Homebrew tap (scripts/update-homebrew-formula.sh) by pushing the regenerated formula to ModernRelay/homebrew-tap, and smoke-tests the Windows PowerShell installer against the tag.
  • package.yml: manual ECR image build; emits two image tags per commit (<sha>, <sha>-aws) via CodeBuild.