Skip to content

Commit ba726b2

Browse files
azuazu
authored
feat(label): Update labels (#4)
- add description - add "Type: CI" label - add "Need More Info" label - update github-labe-sync-@1.4.1
1 parent 444bc07 commit ba726b2

File tree

5 files changed

+196
-132
lines changed

5 files changed

+196
-132
lines changed

‎README.md‎

Lines changed: 24 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -49,35 +49,33 @@ That is opinionated labels.
4949

5050
[![demo](./img/demo.png)](https://github.com/azu/github-label-setup/issues/1)
5151

52-
- duplicate
53-
- Duplicated issue
54-
- help wanted
55-
- help/need idea issue
56-
- good first issue
57-
- Easy to fix issue
58-
- [MunGell/awesome-for-beginners: A list of awesome beginners-friendly projects.](https://github.com/MunGell/awesome-for-beginners "MunGell/awesome-for-beginners: A list of awesome beginners-friendly projects.")
59-
- Priority: Critical
60-
- Priority: High
61-
- Priority: Low
62-
- Priority: Medium
63-
- Status: Abandoned
64-
- Status: Blocked
65-
- Status: In Progress
66-
- Status: Proposal
67-
- Status: PR Welcome
68-
- Status: Review Needed
69-
- Type: Breaking Change
70-
- Type: Bug
71-
- Type: Feature
72-
- Type: Documentation
73-
- Type: Refactoring
74-
- Type: Maintenance
75-
- Type: Testing
76-
- Type is related with [Conventional Commits](https://conventionalcommits.org/ "Conventional Commits")'s type
77-
- Type: Question
52+
- ![#ededed](https://placehold.it/15/ededed/000000?text=+) duplicate - This issue or Pull Request already exists
53+
- ![#e99695](https://placehold.it/15/e99695/000000?text=+) help wanted - Extra attention is needed
54+
- ![#7057ff](https://placehold.it/15/7057ff/000000?text=+) good first issue - Good for newcomers
55+
- ![#ee0701](https://placehold.it/15/ee0701/000000?text=+) Priority: Critical - undefined
56+
- ![#d93f0b](https://placehold.it/15/d93f0b/000000?text=+) Priority: High - undefined
57+
- ![#fbca04](https://placehold.it/15/fbca04/000000?text=+) Priority: Medium - undefined
58+
- ![#0e8a16](https://placehold.it/15/0e8a16/000000?text=+) Priority: Low - undefined
59+
- ![#000000](https://placehold.it/15/000000/000000?text=+) Status: Abandoned - The issue or Pull Request is wontfix
60+
- ![#ee0701](https://placehold.it/15/ee0701/000000?text=+) Status: Blocked - Progress on the issue is Blocked
61+
- ![#cccccc](https://placehold.it/15/cccccc/000000?text=+) Status: In Progress - Work in Progress
62+
- ![#d4c5f9](https://placehold.it/15/d4c5f9/000000?text=+) Status: Proposal - Request for comments
63+
- ![#2E7733](https://placehold.it/15/2E7733/000000?text=+) Status: PR Welcome - Welcome to Pull Request
64+
- ![#fbca04](https://placehold.it/15/fbca04/000000?text=+) Status: Review Needed - Request for review comments
65+
- ![#F9C90A](https://placehold.it/15/F9C90A/000000?text=+) Status: Need More Info - Lacks enough info to make progress
66+
- ![#b60205](https://placehold.it/15/b60205/000000?text=+) Type: Breaking Change - Includes breaking changes
67+
- ![#ee0701](https://placehold.it/15/ee0701/000000?text=+) Type: Bug - Bug or Bug fixes
68+
- ![#5319e7](https://placehold.it/15/5319e7/000000?text=+) Type: Documentation - Documentation only changes
69+
- ![#1d76db](https://placehold.it/15/1d76db/000000?text=+) Type: Feature - New Feature
70+
- ![#fbca04](https://placehold.it/15/fbca04/000000?text=+) Type: Refactoring - A code change that neither fixes a bug nor adds a feature
71+
- ![#257759](https://placehold.it/15/257759/000000?text=+) Type: Testing - Adding missing tests or correcting existing tests
72+
- ![#abd406](https://placehold.it/15/abd406/000000?text=+) Type: Maintenance - Repository Maintenance
73+
- ![#ffd412](https://placehold.it/15/ffd412/000000?text=+) Type: CI - Changes to CI configuration files and scripts
74+
- ![#cc317c](https://placehold.it/15/cc317c/000000?text=+) Type: Question - Further information is requested
7875

7976
## Related
8077

78+
- [Conventional Commits](https://conventionalcommits.org/ "Conventional Commits")
8179
- [yoshuawuyts/github-standard-labels: Create a standard set of issue labels for a GitHub project](https://github.com/yoshuawuyts/github-standard-labels "yoshuawuyts/github-standard-labels: Create a standard set of issue labels for a GitHub project")
8280
- [Financial-Times/github-label-sync: Synchronise your GitHub labels with as few destructive operations as possible](https://github.com/Financial-Times/github-label-sync "Financial-Times/github-label-sync: Synchronise your GitHub labels with as few destructive operations as possible")
8381
- [MunGell/awesome-for-beginners: A list of awesome beginners-friendly projects.](https://github.com/MunGell/awesome-for-beginners "MunGell/awesome-for-beginners: A list of awesome beginners-friendly projects.")

‎labels.json‎

Lines changed: 43 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
11
[
22
{
33
"name": "duplicate",
4-
"color": "ededed"
4+
"color": "ededed",
5+
"description": "This issue or Pull Request already exists"
56
},
67
{
78
"name": "help wanted",
8-
"color": "e99695"
9+
"color": "e99695",
10+
"description": "Extra attention is needed"
911
},
1012
{
1113
"name": "good first issue",
1214
"color": "7057ff",
15+
"description": "Good for newcomers",
1316
"aliases": [
1417
"beginner-friendly",
1518
"beginner",
@@ -28,17 +31,18 @@
2831
"name": "Priority: High",
2932
"color": "d93f0b"
3033
},
31-
{
32-
"name": "Priority: Low",
33-
"color": "0e8a16"
34-
},
3534
{
3635
"name": "Priority: Medium",
3736
"color": "fbca04"
3837
},
38+
{
39+
"name": "Priority: Low",
40+
"color": "0e8a16"
41+
},
3942
{
4043
"name": "Status: Abandoned",
4144
"color": "000000",
45+
"description": "The issue or Pull Request is wontfix",
4246
"aliases": [
4347
"wontfix",
4448
"invalid"
@@ -47,17 +51,20 @@
4751
{
4852
"name": "Status: Blocked",
4953
"color": "ee0701",
54+
"description": "Progress on the issue is Blocked",
5055
"aliases": [
5156
"blocked"
5257
]
5358
},
5459
{
5560
"name": "Status: In Progress",
61+
"description": "Work in Progress",
5662
"color": "cccccc"
5763
},
5864
{
5965
"name": "Status: Proposal",
6066
"color": "d4c5f9",
67+
"description": "Request for comments",
6168
"aliases": [
6269
"idea",
6370
"Idea",
@@ -68,19 +75,27 @@
6875
},
6976
{
7077
"name": "Status: PR Welcome",
71-
"color": "c2e0c6",
78+
"color": "2E7733",
79+
"description": "Welcome to Pull Request",
7280
"aliases": [
7381
"Patch Welcome",
7482
"Status: Ready for PR"
7583
]
7684
},
7785
{
7886
"name": "Status: Review Needed",
79-
"color": "fbca04"
87+
"color": "fbca04",
88+
"description": "Request for review comments"
89+
},
90+
{
91+
"name": "Status: Need More Info",
92+
"color": "F9C90A",
93+
"description": "Lacks enough info to make progress"
8094
},
8195
{
8296
"name": "Type: Breaking Change",
8397
"color": "b60205",
98+
"description": "Includes breaking changes",
8499
"aliases": [
85100
"breaking",
86101
"breaking-change"
@@ -89,13 +104,15 @@
89104
{
90105
"name": "Type: Bug",
91106
"color": "ee0701",
107+
"description": "Bug or Bug fixes",
92108
"aliases": [
93109
"bug"
94110
]
95111
},
96112
{
97113
"name": "Type: Documentation",
98114
"color": "5319e7",
115+
"description": "Documentation only changes",
99116
"aliases": [
100117
"documents",
101118
"document"
@@ -104,38 +121,53 @@
104121
{
105122
"name": "Type: Feature",
106123
"color": "1d76db",
124+
"description": "New Feature",
107125
"aliases": [
108126
"enhancement"
109127
]
110128
},
111129
{
112130
"name": "Type: Refactoring",
113131
"color": "fbca04",
132+
"description": "A code change that neither fixes a bug nor adds a feature",
114133
"aliases": [
115134
"refactor"
116135
]
117136
},
118137
{
119138
"name": "Type: Testing",
120-
"color": "2e8011",
139+
"color": "257759",
140+
"description": "Adding missing tests or correcting existing tests",
121141
"aliases": [
122142
"test",
123143
"testing"
124144
]
125145
},
126146
{
127147
"name": "Type: Maintenance",
128-
"color": "0e8a16",
148+
"color": "abd406",
149+
"description": "Repository Maintenance",
129150
"aliases": [
130151
"greenkeeper",
131152
"maintenance"
132153
]
133154
},
155+
{
156+
"name": "Type: CI",
157+
"color": "ffd412",
158+
"description": "Changes to CI configuration files and scripts",
159+
"aliases": [
160+
"travis",
161+
"ci",
162+
"circleci"
163+
]
164+
},
134165
{
135166
"name": "Type: Question",
136167
"color": "cc317c",
168+
"description": "Further information is requested",
137169
"aliases": [
138170
"question"
139171
]
140172
}
141-
]
173+
]

‎package.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
"devDependencies": {
3838
"babel-cli": "^6.26.0",
3939
"babel-preset-env": "^1.6.1",
40-
"babel-preset-jsdoc-to-assert": "^4.0.0",
40+
"babel-preset-jsdoc-to-assert": "^5.0.0",
4141
"babel-preset-power-assert": "^1.0.0",
4242
"babel-register": "^6.26.0",
4343
"cross-env": "^5.2.0",
@@ -47,9 +47,9 @@
4747
"dependencies": {
4848
"chalk": "^2.3.0",
4949
"git-remote-origin-url": "^3.0.0",
50-
"github-label-sync": "^1.3.0",
50+
"github-label-sync": "^1.4.1",
5151
"hosted-git-info": "^2.5.0",
52-
"meow": "^4.0.0",
52+
"meow": "^5.0.0",
5353
"try-resolve": "^1.0.1"
5454
}
5555
}

‎scripts/readme-labels.js‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
const labels = require("../labels");
2+
const toMarkdown = (label) => {
3+
return `- ![#${label.color}](https://placehold.it/15/${label.color}/000000?text=+) ${label.name} - ${label.description}`;
4+
};
5+
6+
const markdown = labels.map(toMarkdown).join("\n");
7+
console.log(markdown);

0 commit comments

Comments
 (0)