Skip to content

Commit ad2431c

Browse files
addaleaxMylesBorins
authored andcommitted
doc: describe labelling process for backports
Based on discussion from the first backporting team meeting. PR-URL: #12431 Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Myles Borins <[email protected]>
1 parent 7f7a070 commit ad2431c

File tree

1 file changed

+27
-4
lines changed

1 file changed

+27
-4
lines changed

doc/onboarding-extras.md

+27-4
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,33 @@ Please use these when possible / appropriate
7777
git checkout $(git show -s --pretty='%T' $(git show-ref -d $(git describe --abbrev=0) | tail -n1 | awk '{print $1}')) -- test; make -j4 test
7878
```
7979

80+
### LTS/Version labels
81+
82+
We use labels to keep track of which branches a commit should land on:
83+
84+
* `dont-land-on-v?.x`
85+
* For changes that do not apply to a certain release line
86+
* Also used when the work of backporting a change outweighs the benefits
87+
* `land-on-v?.x`
88+
* Used by releasers to mark a PR as scheduled for inclusion in an LTS release
89+
* Applied to the original PR for clean cherry-picks, to the backport PR otherwise
90+
* `backport-requested-v?.x`
91+
* Used to indicate that a PR needs a manual backport to a branch in order to land the changes on that branch
92+
* Typically applied by a releaser when the PR does not apply cleanly or it breaks the tests after applying
93+
* Will be replaced by either `dont-land-on-v?.x` or `backported-to-v?.x`
94+
* `backported-to-v?.x`
95+
* Applied to PRs for which a backport PR has been merged
96+
* `lts-watch-v?.x`
97+
* Applied to PRs which the LTS working group should consider including in a LTS release
98+
* Does not indicate that any specific action will be taken, but can be effective as messaging to non-collaborators
99+
* `lts-agenda`
100+
* For things that need discussion by the LTS working group
101+
* (for example semver-minor changes that need or should go into an LTS release)
102+
* `v?.x`
103+
* Automatically applied to changes that do not target `master` but rather the `v?.x-staging` branch
104+
105+
Once a release line enters maintenance mode, the corresponding labels do not
106+
need to be attached anymore, as only important bugfixes will be included.
80107

81108
### Other Labels
82109

@@ -86,10 +113,6 @@ Please use these when possible / appropriate
86113
* Architecture labels
87114
* `arm`, `mips`
88115
* No x86{_64}, since that is the implied default
89-
* `lts-agenda`, `lts-watch-v*`
90-
* tag things that should be discussed to go into LTS or should go into a specific LTS branch
91-
* (usually only semver-patch things)
92-
* will come more naturally over time
93116

94117

95118
## Updating Node.js from Upstream

0 commit comments

Comments
 (0)