Skip to content

Make filtering by bot authors more discoverable#13642

Open
BagToad wants to merge 3 commits into
trunkfrom
bagtoad/kw-docs-bot-author-filtering
Open

Make filtering by bot authors more discoverable#13642
BagToad wants to merge 3 commits into
trunkfrom
bagtoad/kw-docs-bot-author-filtering

Conversation

@BagToad

@BagToad BagToad commented Jun 12, 2026

Copy link
Copy Markdown
Member

Description

Surface the existing --app flag (for example gh pr list --app dependabot) in --author help text and command examples, and add a short note to the gh agent skill, so filtering by a bot author is discoverable instead of silently returning nothing for --author dependabot.

Key Points

  • The --app flag already exists on pr list, issue list, search prs, and search issues, and expands to author:app/<slug>. Nothing pointed --author users to it, so --author dependabot quietly returns an empty list.
  • --author help text now cross-references --app, and each command gains an --app dependabot example.
  • While in the skill, I also corrected its search guidance. It told agents to pass a whole gh search query as one quoted string, which actually fails with Invalid search query. The working form is separate qualifier tokens or flags.

Notes for reviewers

Three atomic commits:

Additional Context

  • #5888 is the original report that you could not filter by an app author. Good background on why --app exists.
  • #5180 is the PR that added the --app flag this change makes discoverable.

BagToad and others added 3 commits June 12, 2026 10:13
Point --author help text at --app and add examples for filtering by a
GitHub App like Dependabot, so the existing shortcut is discoverable
instead of users trying the broken --author dependabot.

Co-authored-by: Copilot <[email protected]>
gh search parses a bundled quoted query as a single phrase and fails
with "Invalid search query". Document passing each qualifier as its own
token or flag, and note the quoted-string form is only for the --search
flag on pr/issue list.

Co-authored-by: Copilot <[email protected]>
Filtering by --author <bot> matches nothing because bots author as a
GitHub App. Add a bullet covering --app and the [bot] login form.

Co-authored-by: Copilot <[email protected]>
Copilot AI review requested due to automatic review settings June 12, 2026 16:25
@BagToad BagToad requested a review from a team as a code owner June 12, 2026 16:25
@BagToad BagToad requested a review from babakks June 12, 2026 16:25

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates CLI help text and agent guidance to make filtering PRs/issues by GitHub App (bot) authors discoverable, steering users from ineffective --author <app> usage toward the existing --app flag and correct gh search query composition.

Changes:

  • Cross-references --app from --author help text in gh pr/issue list and gh search prs/issues.
  • Adds --app dependabot examples to gh pr list and gh issue list.
  • Updates the skills/gh documentation to reflect correct gh search query tokenization and documents bot author filtering options.
Show a summary per file
File Description
skills/gh/SKILL.md Adjusts agent guidance for gh search syntax and documents bot/GitHub App author filtering.
pkg/cmd/search/prs/prs.go Updates --author help text to point users to --app for GitHub App authors.
pkg/cmd/search/issues/issues.go Updates --author help text to point users to --app for GitHub App authors.
pkg/cmd/pr/list/list.go Adds a --app dependabot example and updates --author help text to reference --app.
pkg/cmd/issue/list/list.go Adds a --app dependabot example and updates --author help text to reference --app.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 5/5 changed files
  • Comments generated: 1

Comment thread skills/gh/SKILL.md
Comment on lines +54 to +55
`gh search issues "repo:cli/cli is:open"` is read as a single phrase and
fails with `Invalid search query`. Quote only multi-word free text

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree with this.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants