From 25c1610e3716b56bcbdf463e2ba968c2b48a7ae5 Mon Sep 17 00:00:00 2001 From: Stuart Leitch Date: Wed, 21 Feb 2024 23:17:19 +0000 Subject: [PATCH 1/3] Clarify helptext for search prs regarding archived repos --- pkg/cmd/search/prs/prs.go | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/pkg/cmd/search/prs/prs.go b/pkg/cmd/search/prs/prs.go index fc68e51cc..96620d1aa 100644 --- a/pkg/cmd/search/prs/prs.go +++ b/pkg/cmd/search/prs/prs.go @@ -55,6 +55,9 @@ func NewCmdPrs(f *cmdutil.Factory, runF func(*shared.IssuesOptions) error) *cobr # search pull requests without label "bug" $ gh search prs -- -label:bug + + # search pull requests only from un-archived repositories (default is all repositories) + $ gh search prs --owner github --archived=false `), RunE: func(c *cobra.Command, args []string) error { if len(args) == 0 && c.Flags().NFlag() == 0 { @@ -145,7 +148,7 @@ func NewCmdPrs(f *cmdutil.Factory, runF func(*shared.IssuesOptions) error) *cobr // Issue query qualifier flags cmd.Flags().StringVar(&appAuthor, "app", "", "Filter by GitHub App author") - cmdutil.NilBoolFlag(cmd, &opts.Query.Qualifiers.Archived, "archived", "", "Restrict search to archived repositories") + cmdutil.NilBoolFlag(cmd, &opts.Query.Qualifiers.Archived, "archived", "", "Filter based on status of the repository archived status {true|false}") cmd.Flags().StringVar(&opts.Query.Qualifiers.Assignee, "assignee", "", "Filter by assignee") cmd.Flags().StringVar(&opts.Query.Qualifiers.Author, "author", "", "Filter by author") cmd.Flags().StringVar(&opts.Query.Qualifiers.Closed, "closed", "", "Filter on closed at `date`") From 19367c645830aa22fb810ec13e4f7b39aeb47d43 Mon Sep 17 00:00:00 2001 From: Stuart Leitch Date: Wed, 21 Feb 2024 23:31:57 +0000 Subject: [PATCH 2/3] fixed whitespace --- pkg/cmd/search/prs/prs.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pkg/cmd/search/prs/prs.go b/pkg/cmd/search/prs/prs.go index 96620d1aa..c36e8590f 100644 --- a/pkg/cmd/search/prs/prs.go +++ b/pkg/cmd/search/prs/prs.go @@ -57,7 +57,7 @@ func NewCmdPrs(f *cmdutil.Factory, runF func(*shared.IssuesOptions) error) *cobr $ gh search prs -- -label:bug # search pull requests only from un-archived repositories (default is all repositories) - $ gh search prs --owner github --archived=false + $ gh search prs --owner github --archived=false `), RunE: func(c *cobra.Command, args []string) error { if len(args) == 0 && c.Flags().NFlag() == 0 { From cfd2d645b28ea3ca78e890815d44a4be7415f0b9 Mon Sep 17 00:00:00 2001 From: Stuart Leitch Date: Thu, 29 Feb 2024 22:38:55 +0000 Subject: [PATCH 3/3] Clarify helptext for `gh search issues` and `gh search repos` regarding archived repos --- pkg/cmd/search/issues/issues.go | 6 +++++- pkg/cmd/search/prs/prs.go | 2 +- pkg/cmd/search/repos/repos.go | 2 +- 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/pkg/cmd/search/issues/issues.go b/pkg/cmd/search/issues/issues.go index e8da9edbb..ec7909747 100644 --- a/pkg/cmd/search/issues/issues.go +++ b/pkg/cmd/search/issues/issues.go @@ -53,6 +53,10 @@ func NewCmdIssues(f *cmdutil.Factory, runF func(*shared.IssuesOptions) error) *c # search issues without label "bug" $ gh search issues -- -label:bug + + # search issues only from un-archived repositories (default is all repositories) + $ gh search issues --owner github --archived=false + `), RunE: func(c *cobra.Command, args []string) error { if len(args) == 0 && c.Flags().NFlag() == 0 { @@ -134,7 +138,7 @@ func NewCmdIssues(f *cmdutil.Factory, runF func(*shared.IssuesOptions) error) *c // Query qualifier flags cmd.Flags().BoolVar(&includePrs, "include-prs", false, "Include pull requests in results") cmd.Flags().StringVar(&appAuthor, "app", "", "Filter by GitHub App author") - cmdutil.NilBoolFlag(cmd, &opts.Query.Qualifiers.Archived, "archived", "", "Restrict search to archived repositories") + cmdutil.NilBoolFlag(cmd, &opts.Query.Qualifiers.Archived, "archived", "", "Filter based on the repository archived state {true|false}") cmd.Flags().StringVar(&opts.Query.Qualifiers.Assignee, "assignee", "", "Filter by assignee") cmd.Flags().StringVar(&opts.Query.Qualifiers.Author, "author", "", "Filter by author") cmd.Flags().StringVar(&opts.Query.Qualifiers.Closed, "closed", "", "Filter on closed at `date`") diff --git a/pkg/cmd/search/prs/prs.go b/pkg/cmd/search/prs/prs.go index c36e8590f..5da7b18f7 100644 --- a/pkg/cmd/search/prs/prs.go +++ b/pkg/cmd/search/prs/prs.go @@ -148,7 +148,7 @@ func NewCmdPrs(f *cmdutil.Factory, runF func(*shared.IssuesOptions) error) *cobr // Issue query qualifier flags cmd.Flags().StringVar(&appAuthor, "app", "", "Filter by GitHub App author") - cmdutil.NilBoolFlag(cmd, &opts.Query.Qualifiers.Archived, "archived", "", "Filter based on status of the repository archived status {true|false}") + cmdutil.NilBoolFlag(cmd, &opts.Query.Qualifiers.Archived, "archived", "", "Filter based on the repository archived state {true|false}") cmd.Flags().StringVar(&opts.Query.Qualifiers.Assignee, "assignee", "", "Filter by assignee") cmd.Flags().StringVar(&opts.Query.Qualifiers.Author, "author", "", "Filter by author") cmd.Flags().StringVar(&opts.Query.Qualifiers.Closed, "closed", "", "Filter on closed at `date`") diff --git a/pkg/cmd/search/repos/repos.go b/pkg/cmd/search/repos/repos.go index 37ea49a90..26bee450e 100644 --- a/pkg/cmd/search/repos/repos.go +++ b/pkg/cmd/search/repos/repos.go @@ -105,7 +105,7 @@ func NewCmdRepos(f *cmdutil.Factory, runF func(*ReposOptions) error) *cobra.Comm cmdutil.StringEnumFlag(cmd, &sort, "sort", "", "best-match", []string{"forks", "help-wanted-issues", "stars", "updated"}, "Sort fetched repositories") // Query qualifier flags - cmdutil.NilBoolFlag(cmd, &opts.Query.Qualifiers.Archived, "archived", "", "Filter based on archive state") + cmdutil.NilBoolFlag(cmd, &opts.Query.Qualifiers.Archived, "archived", "", "Filter based on the repository archived state {true|false}") cmd.Flags().StringVar(&opts.Query.Qualifiers.Created, "created", "", "Filter based on created at `date`") cmd.Flags().StringVar(&opts.Query.Qualifiers.Followers, "followers", "", "Filter based on `number` of followers") cmdutil.StringEnumFlag(cmd, &opts.Query.Qualifiers.Fork, "include-forks", "", "", []string{"false", "true", "only"}, "Include forks in fetched repositories")