weiqingy opened a new pull request, #903: URL: https://github.com/apache/flink-agents/pull/903
Linked issue: #894 ### Purpose of change `AGENTS.md` quotes version facts that live authoritatively somewhere else: the supported Python range and the Ruff line length come from `python/pyproject.toml`, and the Java version comes from the root `pom.xml`. Nothing ties the prose to those sources, so a routine bump can leave the guide quietly wrong, and a stale guide is worse than no guide because agents act on it. This adds `tools/check-agents-md.py`, which derives each fact from its source and fails if `AGENTS.md` no longer quotes it, and runs it as one step in the existing `lint` job. The script is regex-only and dependency-free, so it needs no build and adds no measurable CI time. `AGENTS.md` is accurate on `main` today — this prevents future drift rather than fixing a current mismatch. ### Tests Run against current `main`: passes. Each of the three facts was then bumped in isolation to confirm the check is actually load-bearing rather than passing vacuously: - `requires-python` upper bound `<3.13` to `<3.14` — fails, expecting `3.10 through 3.13`. - Ruff `line-length` `88` to `100` — fails, expecting `100-character line length`. - `target.java.version` `11` to `17` — fails, expecting `Java 17`. The script also exits non-zero if a source pattern cannot be found at all, so a future rename of the underlying option surfaces as a failure instead of a silent pass. ### API No. Tooling and CI only; no production code is touched. ### Documentation - [ ] `doc-needed` - [x] `doc-not-needed` - [ ] `doc-included` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
