X Tutup
Skip to content

Improve help text for --created flag in gh run list#13043

Open
Prakashkuvvam wants to merge 2 commits intocli:trunkfrom
Prakashkuvvam:fix-run-list-created-help
Open

Improve help text for --created flag in gh run list#13043
Prakashkuvvam wants to merge 2 commits intocli:trunkfrom
Prakashkuvvam:fix-run-list-created-help

Conversation

@Prakashkuvvam
Copy link

Summary

Improves help text for the --created flag in gh run list.

Changes

  • Added examples demonstrating supported date filtering syntax
  • Included link to GitHub search syntax documentation
  • Kept flag help concise and moved detailed usage into command help

Why

The --created flag supports GitHub search syntax, but this is not documented in the CLI help. This can lead to confusion and trial-and-error usage.

Example

gh run list --created ">=2024-01-01"
gh run list --created "2024-01-01..2024-02-01"

Testing

  • Verified updated help output using:
    ./bin/gh run list --help
  • Confirmed examples render correctly
  • No functional changes introduced

Closes #12905

@Prakashkuvvam Prakashkuvvam requested a review from a team as a code owner March 26, 2026 07:17
@Prakashkuvvam Prakashkuvvam requested a review from babakks March 26, 2026 07:17
@github-actions github-actions bot added external pull request originating outside of the CLI core team needs-triage needs to be reviewed unmet-requirements and removed needs-triage needs to be reviewed labels Mar 26, 2026
@github-actions
Copy link

Thanks for your pull request! Unfortunately, it doesn't meet the minimum requirements for review:

  • None of the referenced issues have the help wanted label

Please update your PR to address the above. Requirements:

  1. Include a detailed description of what this PR does
  2. Link to an issue with the help wanted label (use Fixes #123 or Closes #123 if it resolves the issue)

This PR will be automatically closed in 7 days if these requirements are not met.

@Prakashkuvvam
Copy link
Author

Happy to extend this pattern to other flags/commands if useful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

external pull request originating outside of the CLI core team unmet-requirements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Further document the date pattern allowed in date CLI params

1 participant

X Tutup