Add detailed Long help text for env get and env update#38947
Merged
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add Long: help text to env get and env update CLI subcommands
Add detailed Jun 12, 2026
Long help text for env get and env update
pelikhan
approved these changes
Jun 12, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Adds long-form --help documentation for gh aw env get and gh aw env update to make default file behavior, scope inference, and update-mode flag interactions discoverable directly from command help output.
Changes:
- Added
Long:help text toenv get [file]describing default output file (file.yml) and scope resolution rules. - Added
Long:help text toenv update [file]describing default input file (file.yml), required--scope, and--dry-run/--yessemantics. - Extended
TestNewEnvCommandto assert that both subcommands have meaningful long help mentioning key concepts/flags.
Show a summary per file
| File | Description |
|---|---|
| pkg/cli/env_command.go | Adds detailed Long help text for env get and env update, documenting file defaults, scope resolution, and update flags. |
| pkg/cli/env_command_test.go | Adds assertions ensuring the new long help text exists and references key concepts/flags. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 2/2 changed files
- Comments generated: 0
This was referenced Jun 12, 2026
Closed
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.
gh aw env getandgh aw env updateonly exposed one-line summaries, leaving default file behavior and scope/flag semantics unclear. This PR adds actionable long-form help for both subcommands so users can understand scope resolution and update-mode flag interactions directly from--help.Help text coverage
Long:docs toenv get [file]andenv update [file].file.yml) when no positional file is provided.repo|org|ent), including inference from--repo/current repo and--enterpriserequirements.update-specific flag semantics:--scopeis required--dry-runpreviews and does not apply changes--yesonly affects real updates (confirmation bypass), not dry runsRegression protection
TestNewEnvCommandto assert meaningful long-help presence and key concepts for both subcommands without coupling tests to brittle exact phrasing.