Agent instructions - refine ort-build skill#28082
Draft
Conversation
- Clarify build.py requires --build_dir and add direct invocation example - Improve incremental build guidance: note when fresh build_dir is needed - Fix --skip_tests description to reflect actual semantics - Refine agent tips: exit code as primary success signal, specific output types per command, precise log redirection advice, clearer long-running build handling, and better explanation of .bat redirection issues Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates the ort-build agent skill documentation to reduce build iteration friction and improve guidance around configuration changes, flag behavior, and build logging/troubleshooting.
Changes:
- Clarifies when
--updateis (and isn’t) required, and recommends using a fresh--build_dirfor major configuration changes. - Adds a direct
build.pyinvocation example and expands guidance on output redirection/log storage. - Refines documentation for
--skip_testsbehavior and adds build success/troubleshooting heuristics.
Comments suppressed due to low confidence (1)
.agents/skills/ort-build/SKILL.md:1
<build_dir>may be treated as an HTML tag in Markdown renderers and disappear or render oddly. Use backticks around the example path (or switch to a placeholder like{build_dir}) so the placeholder reliably displays.
---
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+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.
Description
This pull request updates the
.agents/skills/ort-build/SKILL.mddocumentation to clarify build instructions and improve guidance for agents working with the ONNX Runtime build system. The changes focus on providing clearer recommendations for build configuration, output handling, and troubleshooting.Key documentation improvements:
Build configuration and workflow:
--updateis not needed when modifying existing.cc/.hfiles in an already-configured build tree, and recommended using a fresh--build_dirfor major configuration changes instead of reconfiguring in-place to avoid stale CMake cache issues.build.pydirectly, emphasizing that--build_dirmust be specified when not using wrapper scripts.Flag and option explanations:
--skip_testsflag to clarify its behavior when used with or without explicit phase flags.Build output and troubleshooting:
build.pyusage, and advising agents to store logs under the build directory to keep the repo root clean.Motivation and Context
Attempt to refine ort-build skill.