Repository navigation
Conversation
The full-test recipe can make a passing ordinary test run look like complete Unified validation while leaving the separate consistency checks unselected. Select the existing consistency pack so capture and data-flow failures are visible during that same validation step. The pack is defined at https://github.com/github/codeql/blob/002a731757484fb025354cec495dbf0a570abb7c/unified/ql/consistency-queries/qlpack.yml#L1-L5 and activates the existing checks at https://github.com/github/codeql/blob/002a731757484fb025354cec495dbf0a570abb7c/unified/ql/consistency-queries/CaptureSsaConsistency.ql#L1-L3 and https://github.com/github/codeql/blob/002a731757484fb025354cec495dbf0a570abb7c/unified/ql/consistency-queries/DataFlowConsistency.ql#L1-L5 A matched prior validation episode reached passing ordinary tests before the consistency-enabled invocation exposed failures. The correction preserves the local extractor selection, test directory, rebuild prerequisite and targeted-test procedure. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Maintaining the same manual-edit prohibition in two applicable instruction sources creates redundant policy to keep aligned. The shared instruction already covers every .expected file, including Unified: https://github.com/github/codeql/blob/002a731757484fb025354cec495dbf0a570abb7c/.github/instructions/expected-files.instructions.md#L1-L4 Remove only that duplicate sentence. Keep the local --learn procedure, so readers still have the command needed to regenerate output. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The introductory module identity and build-topology descriptions repeat linked definitions without supplying a separate reader action. Keeping another copy adds upkeep when those definitions change: https://github.com/github/codeql/blob/002a731757484fb025354cec495dbf0a570abb7c/MODULE.bazel#L1-L13 https://github.com/github/codeql/blob/002a731757484fb025354cec495dbf0a570abb7c/.bazelrc#L7-L11 Remove those two descriptive sentences, not the detailed standalone-build procedure. The override-path prohibition and narrow stub-extension exception remain in that procedure: https://github.com/github/codeql/blob/002a731757484fb025354cec495dbf0a570abb7c/.github/skills/bazel/SKILL.md#L151-L171 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
| - If you changed the extractor code, always rebuild it before running CodeQL tests. | ||
|
|
||
| - To run all CodeQL tests, run `codeql test run --search-path extractor-pack ql/test` | ||
| - To run all CodeQL tests, run `codeql test run --search-path extractor-pack --consistency-queries ql/consistency-queries ql/test` |
There was a problem hiding this comment.
🛠️ Complete Unified validation: A passing ordinary test run can leave the separate consistency pack unselected. Including it makes existing consistency failures visible during the full-test step. Commit
| - To run all CodeQL tests, run `codeql test run --search-path extractor-pack --consistency-queries ql/consistency-queries ql/test` | ||
|
|
||
| - Do not edit `.expected` files manually. To update the expected output, pass `--learn` to the `codeql test run` command. | ||
| - To update the expected output, pass `--learn` to the `codeql test run` command. |
There was a problem hiding this comment.
🛠️ One generated-output policy: Keeping the same prohibition in two applicable instruction sources creates redundant policy to maintain. The shared instruction already forbids direct .expected edits, while the local learning command remains. Commit
|
|
||
| # Bazel in the codeql repository | ||
|
|
||
| A bzlmod module named `ql`, repo name `@codeql` ([`MODULE.bazel`](../../../MODULE.bazel)). It builds standalone, and is |
There was a problem hiding this comment.
🧹 Action-focused Bazel guidance: The introductory identity and build-topology prose repeats the module definition and standalone configuration, adding upkeep without a separate reader action. The detailed standalone procedures remain. Commit
There was a problem hiding this comment.
🟢 Approval recommended
No unresolved review issues are identified for these narrowly scoped documentation updates.
No open issues 🎉
What changed in this PR
This documentation-only pull request improves Unified validation guidance and removes duplicated Bazel instructions.
Changes:
- Adds consistency queries to the documented Unified full-test command.
- Retains the
--learnworkflow while relying on shared generated-file guidance. - Removes redundant Bazel background and standalone-build context from the skill overview.
| File | Description |
|---|---|
unified/AGENTS.md |
Updates Unified testing and expected-output guidance, including consistency queries. |
.github/skills/bazel/SKILL.md |
Removes duplicated Bazel background while retaining the detailed build procedures. |
Review effort: Lite (auto)
🧠 How this helps Copilot
Copilot's full Unified test command should include the separate consistency checks, so a passing ordinary test run is not mistaken for complete validation.
Removing a duplicated generated-output prohibition and repeated Bazel background keeps guidance focused on actions without maintaining parallel copies of policy or implementation details. The learning command, shared generated-file policy, and standalone-build procedures remain in place.
Automated details
Source:
curate-memoriesDream, analyzingmainat002a73175748.