Skip to content

Commit f79f964

Browse files
authoredSep 11, 2023
chore: update target labels (#8859)
* update target labels * update renovate config * update changelog label prefix * simplify bug label * fix security label
1 parent 5303448 commit f79f964

9 files changed

+50
-50
lines changed
 

‎.github/renovate.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"extends": [
44
"config:base"
55
],
6-
"labels": ["changelog:dependencies"],
6+
"labels": [":dependabot:", ":label: dependencies"],
77
"packageRules": [
88
{
99
"matchPackagePatterns": [
@@ -116,7 +116,7 @@
116116
"prHourlyLimit": 10,
117117
"vulnerabilityAlerts": {
118118
"labels": [
119-
"security"
119+
":label: security"
120120
],
121121
"automerge": false,
122122
"assignees": [

‎.github/workflows/enforce-pr-labels-beta.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ jobs:
1616
steps:
1717
- uses: yogevbd/enforce-label-action@2.2.2
1818
with:
19-
REQUIRED_LABELS_ANY: 'changelog:breaking,changelog:feat,changelog:bugfix,changelog:perf,changelog:cleanup,changelog:deprecation,changelog:doc,changelog:test,changelog:chore'
20-
REQUIRED_LABELS_ANY_DESCRIPTION: "Select at least one label for changelog generation. ['changelog:breaking', 'changelog:feat', 'changelog:bugfix', 'changelog:perf', 'changelog:cleanup', 'changelog:deprecation', 'changelog:doc', 'changelog:test', 'changelog:chore']"
19+
REQUIRED_LABELS_ANY: ':label: breaking,:label: feat,:label: bug,:label: perf,:label: cleanup,:label: deprecation,:label: doc,:label: test,:label: chore'
20+
REQUIRED_LABELS_ANY_DESCRIPTION: "Select at least one label for changelog generation. [':label: breaking', ':label: feat', ':label: bug', ':label: perf', ':label: cleanup', ':label: deprecation', ':label: doc', ':label: test', ':label: chore']"
2121
ban-target-labels:
2222
runs-on: ubuntu-latest
2323
steps:
2424
- uses: yogevbd/enforce-label-action@2.2.2
2525
with:
26-
BANNED_LABELS: 'target:canary,target:beta,target:release,target:lts,target:lts-prev,changelog:dependencies'
27-
BANNED_LABELS_DESCRIPTION: "These labels should only be used for PRs targeting the main branch, remove them. ['target:canary', 'target:beta', 'target:release', 'target:lts', 'target:lts-prev','changelog:dependencies']"
26+
BANNED_LABELS: ':dart: canary,:dart: beta,:dart: release,:dart: lts,:dart: lts-prev,:label: dependencies'
27+
BANNED_LABELS_DESCRIPTION: "These labels should only be used for PRs targeting the main branch, remove them. [':dart: canary', ':dart: beta', ':dart: release', ':dart: lts', ':dart: lts-prev',':label: dependencies']"
2828
ban-other-release-branch-labels:
2929
runs-on: ubuntu-latest
3030
steps:

‎.github/workflows/enforce-pr-labels-canary.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ jobs:
1616
steps:
1717
- uses: yogevbd/enforce-label-action@2.2.2
1818
with:
19-
REQUIRED_LABELS_ANY: 'changelog:breaking,changelog:feat,changelog:bugfix,changelog:perf,changelog:cleanup,changelog:deprecation,changelog:doc,changelog:test,changelog:chore,changelog:dependencies'
20-
REQUIRED_LABELS_ANY_DESCRIPTION: "Select at least one label for changelog generation. ['changelog:breaking', 'changelog:feat', 'changelog:bugfix', 'changelog:perf', 'changelog:cleanup', 'changelog:deprecation', 'changelog:doc', 'changelog:test', 'changelog:chore', 'changelog:dependencies']"
19+
REQUIRED_LABELS_ANY: ':label: breaking,:label: feat,:label: bug,:label: perf,:label: cleanup,:label: deprecation,:label: doc,:label: test,:label: chore,:label: dependencies'
20+
REQUIRED_LABELS_ANY_DESCRIPTION: "Select at least one label for changelog generation. [':label: breaking', ':label: feat', ':label: bug', ':label: perf', ':label: cleanup', ':label: deprecation', ':label: doc', ':label: test', ':label: chore', ':label: dependencies']"
2121
enforce-target-label:
2222
runs-on: ubuntu-latest
2323
steps:
2424
- uses: yogevbd/enforce-label-action@2.2.2
2525
with:
26-
REQUIRED_LABELS_ANY: 'target:canary,target:beta,target:release,target:lts,target:lts-prev,changelog:dependencies'
27-
REQUIRED_LABELS_ANY_DESCRIPTION: "Select at least one label for what release channels to target. Use the labels `target:canary` or `changelog:dependencies` and none of the others in the list if this PR should not be backported. ['target:canary', 'target:beta', 'target:release', 'target:lts', 'target:lts-prev']"
26+
REQUIRED_LABELS_ANY: ':dart: canary,:dart: beta,:dart: release,:dart: lts,:dart: lts-prev,:label: dependencies'
27+
REQUIRED_LABELS_ANY_DESCRIPTION: "Select at least one label for what release channels to target. Use the labels `:dart: canary` or `:label: dependencies` and none of the others in the list if this PR should not be backported. [':dart: canary', ':dart: beta', ':dart: release', ':dart: lts', ':dart: lts-prev']"
2828
ban-release-branch-labels:
2929
runs-on: ubuntu-latest
3030
steps:

‎.github/workflows/enforce-pr-labels-lts-prev.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ jobs:
1717
steps:
1818
- uses: yogevbd/enforce-label-action@2.2.2
1919
with:
20-
REQUIRED_LABELS_ANY: 'changelog:breaking,changelog:feat,changelog:bugfix,changelog:perf,changelog:cleanup,changelog:deprecation,changelog:doc,changelog:test,changelog:chore'
21-
REQUIRED_LABELS_ANY_DESCRIPTION: "Select at least one label for changelog generation. ['changelog:breaking', 'changelog:feat', 'changelog:bugfix', 'changelog:perf', 'changelog:cleanup', 'changelog:deprecation', 'changelog:doc', 'changelog:test', 'changelog:chore']"
20+
REQUIRED_LABELS_ANY: ':label: breaking,:label: feat,:label: bug,:label: perf,:label: cleanup,:label: deprecation,:label: doc,:label: test,:label: chore'
21+
REQUIRED_LABELS_ANY_DESCRIPTION: "Select at least one label for changelog generation. [':label: breaking', ':label: feat', ':label: bug', ':label: perf', ':label: cleanup', ':label: deprecation', ':label: doc', ':label: test', ':label: chore']"
2222
ban-target-labels:
2323
runs-on: ubuntu-latest
2424
steps:
2525
- uses: yogevbd/enforce-label-action@2.2.2
2626
with:
27-
BANNED_LABELS: 'target:canary,target:beta,target:release,target:lts,target:lts-prev,changelog:dependencies'
28-
BANNED_LABELS_DESCRIPTION: "These labels should only be used for PRs targeting the main branch, remove them. ['target:canary', 'target:beta', 'target:release', 'target:lts', 'target:lts-prev','changelog:dependencies']"
27+
BANNED_LABELS: ':dart: canary,:dart: beta,:dart: release,:dart: lts,:dart: lts-prev,:label: dependencies'
28+
BANNED_LABELS_DESCRIPTION: "These labels should only be used for PRs targeting the main branch, remove them. [':dart: canary', ':dart: beta', ':dart: release', ':dart: lts', ':dart: lts-prev',':label: dependencies']"
2929
ban-other-release-branch-labels:
3030
runs-on: ubuntu-latest
3131
steps:

‎.github/workflows/enforce-pr-labels-lts.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ jobs:
1717
steps:
1818
- uses: yogevbd/enforce-label-action@2.2.2
1919
with:
20-
REQUIRED_LABELS_ANY: 'changelog:breaking,changelog:feat,changelog:bugfix,changelog:perf,changelog:cleanup,changelog:deprecation,changelog:doc,changelog:test,changelog:chore'
21-
REQUIRED_LABELS_ANY_DESCRIPTION: "Select at least one label for changelog generation. ['changelog:breaking', 'changelog:feat', 'changelog:bugfix', 'changelog:perf', 'changelog:cleanup', 'changelog:deprecation', 'changelog:doc', 'changelog:test', 'changelog:chore']"
20+
REQUIRED_LABELS_ANY: ':label: breaking,:label: feat,:label: bug,:label: perf,:label: cleanup,:label: deprecation,:label: doc,:label: test,:label: chore'
21+
REQUIRED_LABELS_ANY_DESCRIPTION: "Select at least one label for changelog generation. [':label: breaking', ':label: feat', ':label: bug', ':label: perf', ':label: cleanup', ':label: deprecation', ':label: doc', ':label: test', ':label: chore']"
2222
ban-target-labels:
2323
runs-on: ubuntu-latest
2424
steps:
2525
- uses: yogevbd/enforce-label-action@2.2.2
2626
with:
27-
BANNED_LABELS: 'target:canary,target:beta,target:release,target:lts,target:lts-prev,changelog:dependencies'
28-
BANNED_LABELS_DESCRIPTION: "These labels should only be used for PRs targeting the main branch, remove them. ['target:canary', 'target:beta', 'target:release', 'target:lts', 'target:lts-prev', 'changelog:dependencies']"
27+
BANNED_LABELS: ':dart: canary,:dart: beta,:dart: release,:dart: lts,:dart: lts-prev,:label: dependencies'
28+
BANNED_LABELS_DESCRIPTION: "These labels should only be used for PRs targeting the main branch, remove them. [':dart: canary', ':dart: beta', ':dart: release', ':dart: lts', ':dart: lts-prev', ':label: dependencies']"
2929
ban-other-release-branch-labels:
3030
runs-on: ubuntu-latest
3131
steps:

‎.github/workflows/enforce-pr-labels-old-release.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ jobs:
1616
steps:
1717
- uses: yogevbd/enforce-label-action@2.2.2
1818
with:
19-
REQUIRED_LABELS_ANY: 'changelog:breaking,changelog:feat,changelog:bugfix,changelog:perf,changelog:cleanup,changelog:deprecation,changelog:doc,changelog:test,changelog:chore'
20-
REQUIRED_LABELS_ANY_DESCRIPTION: "Select at least one label for changelog generation. ['changelog:breaking', 'changelog:feat', 'changelog:bugfix', 'changelog:perf', 'changelog:cleanup', 'changelog:deprecation', 'changelog:doc', 'changelog:test', 'changelog:chore']"
19+
REQUIRED_LABELS_ANY: ':label: breaking,:label: feat,:label: bug,:label: perf,:label: cleanup,:label: deprecation,:label: doc,:label: test,:label: chore'
20+
REQUIRED_LABELS_ANY_DESCRIPTION: "Select at least one label for changelog generation. [':label: breaking', ':label: feat', ':label: bug', ':label: perf', ':label: cleanup', ':label: deprecation', ':label: doc', ':label: test', ':label: chore']"
2121
ban-target-labels:
2222
runs-on: ubuntu-latest
2323
steps:
2424
- uses: yogevbd/enforce-label-action@2.2.2
2525
with:
26-
BANNED_LABELS: 'target:canary,target:beta,target:release,target:lts,target:lts-prev,changelog:dependencies'
27-
BANNED_LABELS_DESCRIPTION: "These labels should only be used for PRs targeting the main branch, remove them. ['target:canary', 'target:beta', 'target:release', 'target:lts', 'target:lts-prev', 'changelog:dependencies']"
26+
BANNED_LABELS: ':dart: canary,:dart: beta,:dart: release,:dart: lts,:dart: lts-prev,:label: dependencies'
27+
BANNED_LABELS_DESCRIPTION: "These labels should only be used for PRs targeting the main branch, remove them. [':dart: canary', ':dart: beta', ':dart: release', ':dart: lts', ':dart: lts-prev', ':label: dependencies']"
2828
ban-other-release-branch-labels:
2929
runs-on: ubuntu-latest
3030
steps:

‎.github/workflows/enforce-pr-labels-release.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ jobs:
1616
steps:
1717
- uses: yogevbd/enforce-label-action@2.2.2
1818
with:
19-
REQUIRED_LABELS_ANY: 'changelog:breaking,changelog:feat,changelog:bugfix,changelog:perf,changelog:cleanup,changelog:deprecation,changelog:doc,changelog:test,changelog:chore'
20-
REQUIRED_LABELS_ANY_DESCRIPTION: "Select at least one label for changelog generation. ['changelog:breaking', 'changelog:feat', 'changelog:bugfix', 'changelog:perf', 'changelog:cleanup', 'changelog:deprecation', 'changelog:doc', 'changelog:test', 'changelog:chore']"
19+
REQUIRED_LABELS_ANY: ':label: breaking,:label: feat,:label: bug,:label: perf,:label: cleanup,:label: deprecation,:label: doc,:label: test,:label: chore'
20+
REQUIRED_LABELS_ANY_DESCRIPTION: "Select at least one label for changelog generation. [':label: breaking', ':label: feat', ':label: bug', ':label: perf', ':label: cleanup', ':label: deprecation', ':label: doc', ':label: test', ':label: chore']"
2121
ban-target-labels:
2222
runs-on: ubuntu-latest
2323
steps:
2424
- uses: yogevbd/enforce-label-action@2.2.2
2525
with:
26-
BANNED_LABELS: 'target:canary,target:beta,target:release,target:lts,target:lts-prev,changelog:dependencies'
27-
BANNED_LABELS_DESCRIPTION: "These labels should only be used for PRs targeting the main branch, remove them. ['target:canary', 'target:beta', 'target:release', 'target:lts', 'target:lts-prev', 'changelog:dependencies']"
26+
BANNED_LABELS: ':dart: canary,:dart: beta,:dart: release,:dart: lts,:dart: lts-prev,:label: dependencies'
27+
BANNED_LABELS_DESCRIPTION: "These labels should only be used for PRs targeting the main branch, remove them. [':dart: canary', ':dart: beta', ':dart: release', ':dart: lts', ':dart: lts-prev', ':label: dependencies']"
2828
ban-other-release-branch-labels:
2929
runs-on: ubuntu-latest
3030
steps:

‎contributing/submitting-prs.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -46,28 +46,28 @@ Labels used for the changelog include any labels listed in the changelog config
4646

4747
These labels are prefixed with `changelog:` and currently the options are:
4848

49-
- `changelog:breaking` which should be used to signify a breaking change
50-
- `changelog:feat` which should be used to signify an addition of a new public feature or behavior
51-
- `changelog:bugfix` which should be used to signify a fix for a reported issue
52-
- `changelog:perf` which should be used to signify that the commit will improve performance characteristics in a meaningful way
53-
- `changelog:cleanup` which should be used to signify removal of deprecated features or that a deprecation has become an assertion.
54-
- `changelog:deprecation` which should be used to signify addition of a new deprecation
55-
- `changelog:doc` which should be used to signify a fix or improvement to documentation generated for api.emberjs.com
56-
- `changelog:test` which should be used to signify addition of new tests or refactoring of existing tests
57-
- `changelog:chore` which should be used to signify refactoring of internal code that should not have an affect on public APIs or behaviors but which we may want to call out for potentially unintended consequences.
58-
- `changelog:dependencies` which should be used when bumping dependencies on `main`. Bumps on other branches should use other labels as this implies a more substantive change.
49+
- `:label: breaking` which should be used to signify a breaking change
50+
- `:label: feat` which should be used to signify an addition of a new public feature or behavior
51+
- `:label: bug` which should be used to signify a fix for a reported issue
52+
- `:label: perf` which should be used to signify that the commit will improve performance characteristics in a meaningful way
53+
- `:label: cleanup` which should be used to signify removal of deprecated features or that a deprecation has become an assertion.
54+
- `:label: deprecation` which should be used to signify addition of a new deprecation
55+
- `:label: doc` which should be used to signify a fix or improvement to documentation generated for api.emberjs.com
56+
- `:label: test` which should be used to signify addition of new tests or refactoring of existing tests
57+
- `:label: chore` which should be used to signify refactoring of internal code that should not have an affect on public APIs or behaviors but which we may want to call out for potentially unintended consequences.
58+
- `:label: dependencies` which should be used when bumping dependencies on `main`. Bumps on other branches should use other labels as this implies a more substantive change.
5959

6060
#### Backporting Labels
6161

6262
We use one set of labels to indicate that a PR needs to be backported and where it needs to be backported to, and a second set of labels to indicate that a PR **is** the backport PR.
6363

6464
To indicate that a PR should be backported, the following labels, all prefixed with `target:` are available:
6565

66-
- `target:canary` indicates that a PR will not require backporting.
67-
- `target:beta` indicates the PR requires being backported to the current beta release.
68-
- `target:release` indicates the PR requires being backported to the current active release.
69-
- `target:lts` indicates that a PR requires being backported to the most current LTS release.
70-
- `target:lts-prev` indicates that a PR requires being backported to the second-most recent LTS release.
66+
- `:dart: canary` indicates that a PR will not require backporting.
67+
- `:dart: beta` indicates the PR requires being backported to the current beta release.
68+
- `:dart: release` indicates the PR requires being backported to the current active release.
69+
- `:dart: lts` indicates that a PR requires being backported to the most current LTS release.
70+
- `:dart: lts-prev` indicates that a PR requires being backported to the second-most recent LTS release.
7171

7272
Note: a PR should add the individual label for _every_ backport target required. We use this while releasing to search
7373
for any commits still requiring backport to include, and will eventually automate opening backport PRs via a bot when

‎package.json

+9-9
Original file line numberDiff line numberDiff line change
@@ -95,15 +95,15 @@
9595
"packageManager": "pnpm@8.7.4",
9696
"changelog": {
9797
"labels": {
98-
"changelog:breaking": ":boom: Breaking Change",
99-
"changelog:feat": ":rocket: Enhancement",
100-
"changelog:bugfix": ":bug: Bug Fix",
101-
"changelog:perf:": ":zap: Performance",
102-
"changelog:cleanup": ":shower: Deprecation Removal",
103-
"changelog:deprecation": ":evergreen_tree: New Deprecation",
104-
"changelog:doc": ":memo: Documentation",
105-
"changelog:test": ":goal_net: Test",
106-
"changelog:chore": ":house: Internal"
98+
":label: breaking": ":boom: Breaking Change",
99+
":label: feat": ":rocket: Enhancement",
100+
":label: bug": ":bug: Bug Fix",
101+
":label: perf:": ":zap: Performance",
102+
":label: cleanup": ":shower: Deprecation Removal",
103+
":label: deprecation": ":evergreen_tree: New Deprecation",
104+
":label: doc": ":memo: Documentation",
105+
":label: test": ":goal_net: Test",
106+
":label: chore": ":house: Internal"
107107
}
108108
},
109109
"pnpm": {

0 commit comments

Comments
 (0)
Please sign in to comment.