Skip to content

Commit 3efd4d9

Browse files
BagToadCopilot
BagToad
and
Copilot
committed
docs(pr, issue, search): surface --app flag for bot authors
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]>
1 parent 57b9b20 commit 3efd4d9

4 files changed

Lines changed: 8 additions & 4 deletions

File tree

‎pkg/cmd/issue/list/list.go‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Comman
7474
Example: heredoc.Doc(`
7575
$ gh issue list --label "bug" --label "help wanted"
7676
$ gh issue list --author monalisa
77+
$ gh issue list --app dependabot
7778
$ gh issue list --assignee "@me"
7879
$ gh issue list --milestone "The big 1.0"
7980
$ gh issue list --search "error no:assignee sort:created-asc"
@@ -110,7 +111,7 @@ func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Comman
110111
cmd.Flags().StringSliceVarP(&opts.Labels, "label", "l", nil, "Filter by label")
111112
cmdutil.StringEnumFlag(cmd, &opts.State, "state", "s", "open", []string{"open", "closed", "all"}, "Filter by state")
112113
cmd.Flags().IntVarP(&opts.LimitResults, "limit", "L", 30, "Maximum number of issues to fetch")
113-
cmd.Flags().StringVarP(&opts.Author, "author", "A", "", "Filter by author")
114+
cmd.Flags().StringVarP(&opts.Author, "author", "A", "", "Filter by author (use --app to filter by a GitHub App)")
114115
cmd.Flags().StringVar(&appAuthor, "app", "", "Filter by GitHub App author")
115116
cmd.Flags().StringVar(&opts.Mention, "mention", "", "Filter by mention")
116117
cmd.Flags().StringVarP(&opts.Milestone, "milestone", "m", "", "Filter by milestone number or title")

‎pkg/cmd/pr/list/list.go‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,9 @@ func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Comman
7272
# List PRs authored by you
7373
$ gh pr list --author "@me"
7474
75+
# List PRs opened by a GitHub App such as Dependabot
76+
$ gh pr list --app dependabot
77+
7578
# List PRs with a specific head branch name
7679
$ gh pr list --head "typo"
7780
@@ -115,7 +118,7 @@ func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Comman
115118
cmd.Flags().StringVarP(&opts.BaseBranch, "base", "B", "", "Filter by base branch")
116119
cmd.Flags().StringVarP(&opts.HeadBranch, "head", "H", "", `Filter by head branch ("<owner>:<branch>" syntax not supported)`)
117120
cmd.Flags().StringSliceVarP(&opts.Labels, "label", "l", nil, "Filter by label")
118-
cmd.Flags().StringVarP(&opts.Author, "author", "A", "", "Filter by author")
121+
cmd.Flags().StringVarP(&opts.Author, "author", "A", "", "Filter by author (use --app to filter by a GitHub App)")
119122
cmd.Flags().StringVar(&appAuthor, "app", "", "Filter by GitHub App author")
120123
cmd.Flags().StringVarP(&opts.Assignee, "assignee", "a", "", "Filter by assignee")
121124
cmd.Flags().StringVarP(&opts.Search, "search", "S", "", "Search pull requests with `query`")

‎pkg/cmd/search/issues/issues.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ func NewCmdIssues(f *cmdutil.Factory, runF func(*shared.IssuesOptions) error) *c
147147
cmd.Flags().StringVar(&appAuthor, "app", "", "Filter by GitHub App author")
148148
cmdutil.NilBoolFlag(cmd, &opts.Query.Qualifiers.Archived, "archived", "", "Filter based on the repository archived state {true|false}")
149149
cmd.Flags().StringVar(&opts.Query.Qualifiers.Assignee, "assignee", "", "Filter by assignee")
150-
cmd.Flags().StringVar(&opts.Query.Qualifiers.Author, "author", "", "Filter by author")
150+
cmd.Flags().StringVar(&opts.Query.Qualifiers.Author, "author", "", "Filter by author (use --app to filter by a GitHub App)")
151151
cmd.Flags().StringVar(&opts.Query.Qualifiers.Closed, "closed", "", "Filter on closed at `date`")
152152
cmd.Flags().StringVar(&opts.Query.Qualifiers.Commenter, "commenter", "", "Filter based on comments by `user`")
153153
cmd.Flags().StringVar(&opts.Query.Qualifiers.Comments, "comments", "", "Filter on `number` of comments")

‎pkg/cmd/search/prs/prs.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ func NewCmdPrs(f *cmdutil.Factory, runF func(*shared.IssuesOptions) error) *cobr
158158
cmd.Flags().StringVar(&appAuthor, "app", "", "Filter by GitHub App author")
159159
cmdutil.NilBoolFlag(cmd, &opts.Query.Qualifiers.Archived, "archived", "", "Filter based on the repository archived state {true|false}")
160160
cmd.Flags().StringVar(&opts.Query.Qualifiers.Assignee, "assignee", "", "Filter by assignee")
161-
cmd.Flags().StringVar(&opts.Query.Qualifiers.Author, "author", "", "Filter by author")
161+
cmd.Flags().StringVar(&opts.Query.Qualifiers.Author, "author", "", "Filter by author (use --app to filter by a GitHub App)")
162162
cmd.Flags().StringVar(&opts.Query.Qualifiers.Closed, "closed", "", "Filter on closed at `date`")
163163
cmd.Flags().StringVar(&opts.Query.Qualifiers.Commenter, "commenter", "", "Filter based on comments by `user`")
164164
cmd.Flags().StringVar(&opts.Query.Qualifiers.Comments, "comments", "", "Filter on `number` of comments")

0 commit comments

Comments
 (0)