[UPDATE PRIMITIVE] Fix CallGraph docs: remove IDE integration claim, fix output format, fix NON_COMPLIANT typo#83
Merged
data-douser merged 2 commits intodd/release-prep/3from Feb 24, 2026
Conversation
Merged
…ackticks, fix NON_COMPLIANT typo Co-authored-by: data-douser <70299490+data-douser@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Address feedback on CallGraphFrom and CallGraphTo usage
[UPDATE PRIMITIVE] Fix CallGraph docs: remove IDE integration claim, fix output format, fix NON_COMPLIANT typo
Feb 24, 2026
data-douser
approved these changes
Feb 24, 2026
data-douser
added a commit
that referenced
this pull request
Feb 24, 2026
* Enforce release version and tag consistency * fix(release-tag): detect and replace stale tags Add a lightweight version check in the check-tag step that inspects server/package.json at the tagged commit. If the version doesn't match the release name, the stale tag is deleted and recreated with correct versions through the normal update/build/test/tag flow. Also suppress stderr on git restore --staged for paths that may not exist (.codeql, *.qlx). * Release v2.24.2-rc1: update versions to 2.24.2-rc1 * Allow codeql pack prerelease * Release v2.24.2-rc2: update versions to 2.24.2-rc2 * fix VSIX-bundled server install & version artifacts VSIX install fixes: - Skip npm install entirely when the VSIX bundle is present; the bundle already ships server/dist/, server/ql/, and server/package.json - PackInstaller now prefers bundled qlpacks from the VSIX over the npm-installed copy in globalStorage, fixing version skew between the packs being installed and the server code being run - In the unbundled fallback path (Extension Development Host), compare the npm-installed version against the extension's own version instead of short-circuiting on targetVersion === 'latest' Versioned release artifact filenames: - VSIX: codeql-development-mcp-server-vX.Y.Z.vsix (was unversioned) - CodeQL pack bundles: ql-mcp-<lang>-tools-src-vX.Y.Z.tar.gz (was unversioned) - Update release, build-and-test, and package scripts accordingly - Add *.vsix to .gitignore - Normalize docs to use vX.Y.Z placeholders consistently * Add `.md` docs for all `.ql` tools queries (#78) (#79) * Add .md docs for all tools queries (#78) Add query documentation (.md) for every `server/ql/*/tools/src/*/*.ql` query across all 9 supported languages: PrintAST, PrintCFG, CallGraphFrom, and CallGraphTo. - Add `query-documentation.test.ts` to enforce that every tools query has a matching .md file - Update `server_ql_languages_tools.instructions.md` to require query docs, clarify `@kind graph` vs detection-query guidance, and scope COMPLIANT/NON_COMPLIANT annotations to detection queries only - Remove COMPLIANT/NON_COMPLIANT annotations from existing PrintCFG docs (structural queries, not detection queries) * Apply suggestions from code review Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Nathan Randall <70299490+data-douser@users.noreply.github.com> * [UPDATE PRIMITIVE] Consistent `CallGraphFrom`/`CallGraphTo` naming in all language docs (#80) * Initial plan * Use CallGraphFrom and CallGraphTo naming consistently in all docs (no spaces) Co-authored-by: data-douser <70299490+data-douser@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: data-douser <70299490+data-douser@users.noreply.github.com> * Update server/ql/cpp/tools/src/CallGraphFrom/CallGraphFrom.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Nathan Randall <70299490+data-douser@users.noreply.github.com> --------- Signed-off-by: Nathan Randall <70299490+data-douser@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> * Release v2.24.2-rc3: update versions to 2.24.2-rc3 * Fix `getExtensionVersion()` and `getBundledQlRoot()` per review comments (#82) * Initial plan * Fix getExtensionVersion() and getBundledQlRoot() per review comments Co-authored-by: data-douser <70299490+data-douser@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: data-douser <70299490+data-douser@users.noreply.github.com> * [UPDATE PRIMITIVE] Fix CallGraph docs: remove IDE integration claim, fix output format, fix NON_COMPLIANT typo (#83) --------- Signed-off-by: Nathan Randall <70299490+data-douser@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Three documentation correctness fixes across all 16
CallGraph{From,To}.mdfiles (8 languages) and the shared instructions file, addressing review feedback on #81.📝 Update Information
Primitive Details
CallGraphFrom,CallGraphTo(all languages: cpp, csharp, go, java, javascript, python, ruby, swift)✅ ALLOWED FILES:
server/ql/*/tools/src/CallGraph{From,To}/*.md).github/instructions/server_ql_languages_tools.instructions.md)🛑 MANDATORY PR VALIDATION CHECKLIST
Update Metadata
🎯 Changes Description
Current Behavior
All
CallGraph{From,To}.mdfiles incorrectly listed "IDE integration for call hierarchy navigation" as a use case. The example message patterns and Output Format sections used single-quoted placeholders ('source','callee') that don't match the actual query output, which uses backtick-quoted names. The instructions file had aNON-COMPLIANThyphen typo (should be underscore, consistent withNON_COMPLIANTused elsewhere).Updated Behavior
NON-COMPLIANT→NON_COMPLIANTin.github/instructions/server_ql_languages_tools.instructions.md.Motivation
The IDE integration claim was inaccurate — these queries are standalone call-graph analysis tools, not IDE call hierarchy providers. The single-quoted output format conflicted with what the
.qlfiles actually produce (backtick-wrapped names via string concatenation), causing user confusion when comparing docs to actual results.🔄 Before vs. After Comparison
Functionality Changes
No functional changes — documentation corrections only.
API Changes
None.
Output Format Changes
No change to actual query output. Documentation now accurately reflects the existing backtick format.
🧪 Testing & Validation
Test Coverage Updates
Validation Scenarios
Test Results
codeql_pack_install/install_pack📋 Implementation Details
Files Modified
server/ql/{cpp,csharp,go,java,javascript,python,ruby,swift}/tools/src/CallGraph{From,To}/CallGraph{From,To}.md(16 files).github/instructions/server_ql_languages_tools.instructions.mdCode Changes Summary
NON_COMPLIANTtypoDependencies
🔍 Quality Improvements
Bug Fixes (if applicable)
.mdfilesselectstring interpolationCode Quality Enhancements
🔗 References
Related Issues/PRs
v2.24.2release #81🚀 Compatibility & Migration
Backward Compatibility
API Evolution
👥 Review Guidelines
For Reviewers
Please verify:
Testing Instructions
📊 Impact Assessment
Server Impact
AI Assistant Impact
🔄 Deployment Strategy
Rollout Considerations
Update Methodology: This update follows best practices:
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.