Document compile --no-models-dev-lookup and add CLI docs regression coverage#43339
Merged
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix missing --no-models-dev-lookup in compile command docs
Document Jul 4, 2026
compile --no-models-dev-lookup and add CLI docs regression coverage
Contributor
There was a problem hiding this comment.
Pull request overview
This PR keeps the published gh aw compile CLI reference aligned with the actual Cobra flag surface by documenting the already-supported --no-models-dev-lookup flag and adding a regression test to prevent future docs drift.
Changes:
- Documented
--no-models-dev-lookupin thegh aw compileoptions list in the setup CLI docs. - Added a Go test asserting the
compiledocs section includes--no-models-dev-lookup.
Show a summary per file
| File | Description |
|---|---|
| pkg/cli/cli_consistency_help_test.go | Adds regression coverage to ensure the CLI docs’ compile section includes --no-models-dev-lookup. |
| docs/src/content/docs/setup/cli.md | Updates the compile Options list to include --no-models-dev-lookup. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 2/2 changed files
- Comments generated: 1
- Review effort level: Low
Comment on lines
+61
to
+65
| compileIndex := strings.Index(text, "#### `compile`") | ||
| require.NotEqual(t, -1, compileIndex, "CLI setup docs should contain the compile section") | ||
|
|
||
| compileSection := text[compileIndex:] | ||
| assert.Contains(t, compileSection, "`--no-models-dev-lookup`", "compile docs options should include --no-models-dev-lookup") |
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.
The
gh aw compiledocs were missing a public flag that is already exposed by the CLI:--no-models-dev-lookup. This creates drift between the documented and actual command surface forcompile.Docs
--no-models-dev-lookupto thegh aw compileOptions list indocs/src/content/docs/setup/cli.mdRegression coverage
pkg/cli/cli_consistency_help_test.gowith a focused assertion that thecompilesection in the CLI docs includes--no-models-dev-lookupResult
compilereference aligned with the public Cobra flag set