diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 45d2f1f..65d1e24 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,23 +16,6 @@ cargo test --workspace If you touch S3-backed flows, the CI model uses a local RustFS instance for integration tests. -### OpenAPI spec - -`openapi.json` is a committed artifact generated from the Utoipa annotations in -`crates/omnigraph-server`. CI fails if it drifts from the source. To regenerate -manually: - -```bash -OMNIGRAPH_UPDATE_OPENAPI=1 cargo test -p omnigraph-server --test openapi openapi_spec_is_up_to_date -``` - -Optional: enable the project's git hook to regenerate automatically when you -commit server changes: - -```bash -git config core.hooksPath scripts/hooks -``` - ## Pull Requests - keep changes focused diff --git a/scripts/hooks/pre-commit b/scripts/hooks/pre-commit deleted file mode 100755 index 6fe8d8f..0000000 --- a/scripts/hooks/pre-commit +++ /dev/null @@ -1,15 +0,0 @@ -#!/usr/bin/env bash -# Regenerate openapi.json when the server API surface changes. -set -euo pipefail - -staged=$(git diff --cached --name-only --diff-filter=ACMR) - -echo "$staged" | grep -qE '^(crates/omnigraph-server/src/.*\.rs|crates/omnigraph-server/Cargo\.toml)$' || exit 0 - -echo "[pre-commit] regenerating openapi.json..." -OMNIGRAPH_UPDATE_OPENAPI=1 cargo test -p omnigraph-server --test openapi openapi_spec_is_up_to_date --quiet - -if ! git diff --quiet -- openapi.json; then - git add openapi.json - echo "[pre-commit] openapi.json updated and staged" -fi