Improvements to label list

Based on comments, I think there's a few improvements we should make to label list:

Do not limit results by default. There seems to be no customer value unless they explicitly want to limit results.

To clarify, it is used as the page size and does support paging, but lines 67-69 of this block of code should be removed:

cli/pkg/cmd/label/list/http.go

Lines 65 to 70 in c99c47f

    
           for _, label := range response.Repository.Labels.Nodes { 
        
           	labels = append(labels, label) 
        
           	if len(labels) == limit { 
        
           		break loop 
        
           	} 
        
           }

One reason they might want to limit results is to filter the list, much like you can filter issues or PRs. Like heaths/gh-label we could either tag an optional argument for the filter term, or a --search parameter like issue list has for consistency. The former would only be breaking if someone actually expected an error with an additional arg, but that seems like an impractical test. The latter would be consistent with issue list and pr list, however.
Sort results by default. A large list of unsorted labels is difficult to read and find what you want. The order returned is also not documented and should not be relied on.

On a related note, should at least a label remove command as well. A label edit might also be useful, but a label create --force will accomplish the same thing.

I responded inline regarding these proposals, so I will just briefly summarize here.

I am not convinced that removing the default limit is the right direction for a couple reasons.
I am onboard with adding --order and --search flags with functionality that is backed by the API. Adding this functionality makes the default limit more valuable IMO.
The labels are ordered by created at date when returned from the API.
A label remove command makes sense to me but label edit seems redundant with label create --force. Perhaps that is okay though since label edit is more discoverable and explicit.

@samcoe

@samcoe I've got this nearly finished, but found a bug with the LabelConnection GraphQL type: if you specify a query, the orderBy has no effect. I can work around this, but would be great to see a fix for GraphQL.

Add search and sort options to `label list`

I've got this done but waiting for #5452 so I can rebase it onto trunk and submit a clean PR.

Add search and sort options to `label list`

Navigation Menu

Repository navigation

Improvements to `label list` #5489

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

	for _, label := range response.Repository.Labels.Nodes {
	labels = append(labels, label)
	if len(labels) == limit {
	break loop
	}
	}

Improvements to label list #5489

Description

Activity

heaths commented on Apr 20, 2022

samcoe commented on Apr 21, 2022

Griffin641498 commented on Apr 22, 2022

heaths commented on Apr 22, 2022

heaths commented on Apr 22, 2022

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions

Improvements to `label list` #5489