Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide ability to configure default labels #188

Closed
gep13 opened this issue Jan 11, 2020 · 9 comments
Closed

Provide ability to configure default labels #188

gep13 opened this issue Jan 11, 2020 · 9 comments
Assignees
Labels
Milestone

Comments

@gep13
Copy link
Member

gep13 commented Jan 11, 2020

Detailed Description

To remove the hard coded nature of the current implementation.

Context

Right now, the set of default labels that are used when executing the label command are hard coded into GRM. The values that were chosen were the ones that I use personally, but this isn't ideal. We need to provide the ability to configure what default labels are created when running the label command.

Possible Implementation

The default labels should be part of the configuration that can be added to the YAML file.

@gep13 gep13 added this to the 0.11.0 milestone Jan 11, 2020
@gep13 gep13 modified the milestones: 0.11.0, 0.12.0 Mar 16, 2020
@akordowski
Copy link
Contributor

akordowski commented Jul 24, 2020

While testing the label command recently I had the same idea.

The default yaml config contains following labels:

Bug
Duplicate
Enhancement
Feature
Help Wanted
Improvement
Invalid
Question
Wontfix
Internal Refactoring

the label command creates following labels:

Breaking change
Bug
Build
Documentation
Feature
Improvement
Question
good first issue
help wanted

which are not even consistent.

I would like to suggest following implementation. Add a new section for the label command (like create, export), with name, description and color for the label. The definition could look like this:

label:
  - name: 'Bug'
    description: 'Something isn't working'
    color: 'd73a4a'
  - name: 'Documentation'
    description: 'Improvements or additions to documentation'
    color: '0075ca'
  - name: 'Duplicate'
    description: 'This issue or pull request already exists'
    color: 'cfd3d7'
  - name: 'Enhancement'
    description: 'New feature or request'
    color: 'a2eeef'
  - name: 'Feature'
    description: 'Request for a new feature'
    color: '009800'
  - name: 'Good First Issue'
    description: 'Good for newcomers'
    color: '7057ff'
  - name: 'Help Wanted'
    description: 'Extra attention is needed'
    color: '008672'
  - name: 'Improvement'
    description: 'Improvement of a existing feature'
    color: 'fbca04'
  - name: 'Internal Refactoring'
    description: 'Refactor internal code'
    color: 'd4c5f9'
  - name: 'Invalid'
    description: 'This doesn't seem right'
    color: 'e4e669'
  - name: 'Question'
    description: 'Further information is requested'
    color: 'd876e3'
  - name: 'Wont Fix'
    description: 'This will not be worked on'
    color: 'ffffff'

Additionaly following labels could be added too:

- name: 'Breaking Change'
  description: 'Functionality breaking changes'
  color: 'd85867'
- name: 'Build'
  description: ''
  color: '006b75'
- name: 'Investigating'
  description: ''
  color: '006b75'

I would like to implement the changes and provide a PR.

@gep13
Copy link
Member Author

gep13 commented Jul 25, 2020

@akordowski sorry, missed this update when going through things earlier.

If you wanted to have a stab at implementing this, I would be more than happy to review a PR.

Thanks

@akordowski
Copy link
Contributor

Should I add all suggested labels or without the last three?

@AdmiringWorm
Copy link
Member

@akordowski @gep13 I believe adding additional labels would be a separate enhancement request in additional to this feature request, and deserves its own issue.

As such, for this specific issue only making the labels configurable but without adding any new ones would be appropriate IMO.

@akordowski
Copy link
Contributor

So only the suggested? They contains the default GitHub labels plus Improvement, Internal Refactoring.

@AdmiringWorm
Copy link
Member

I would say only

Breaking change
Bug
Build
Documentation
Feature
Improvement
Question
good first issue
help wanted

As these are the current defaults created by GRM: https://github.com/GitTools/GitReleaseManager/blob/develop/Source/GitReleaseManager/GitHubProvider.cs#L348-L356

Anything additional would be part of a new enhancement request.
But as I said, that is just my opinion, and it would be up to @gep13 whether to include them under the same request or not.

gep13 added a commit that referenced this issue Jul 26, 2020
gittools-bot pushed a commit that referenced this issue Jul 26, 2020
Merge pull request #258 from akordowski/feature/GH-188-configure-default-labels

(GH-188) Configure default labels
@akordowski
Copy link
Contributor

@gep13 Issue can be closed.

@gep13
Copy link
Member Author

gep13 commented Aug 25, 2020

@akordowski agreed, thanks for following up on this one.

@gep13 gep13 closed this as completed Aug 25, 2020
@gittools-bot
Copy link

🎉 This issue has been resolved in version 0.12.0 🎉

The release is available on:

Your GitReleaseManager bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants