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

doc: clarify who may land on an LTS staging branch #24465

Closed
wants to merge 5 commits into from

Conversation

MylesBorins
Copy link
Contributor

Current language is a bit confusing

Refs: #24344 (comment)

Current language is a bit confusing
@nodejs-github-bot
Copy link
Collaborator

@MylesBorins sadly an error occured when I tried to trigger a build :(

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Nov 18, 2018
@targos
Copy link
Member

targos commented Nov 18, 2018

This paragraph is part of "How are LTS Branches Managed?" so it doesn't really make sense to have a rule about non-LTS branches in it IMHO.

@MylesBorins
Copy link
Contributor Author

@targos I'm trying to figure out the intention of the original language as compared to what is documented in https://github.com/nodejs/release#lts-staging-branches

Perhaps it is better to just point at the Release repo as the source of truth?

@refack
Copy link
Contributor

refack commented Nov 18, 2018

I read the same semantics in https://github.com/nodejs/release#lts-staging-branches

Every LTS major version has two branches in the GitHub repository: a release branch and a staging branch. The release branch is used to cut new releases. Only members of the release team should land commits into the release branch. The staging branch is used to land cherry-picked or backported commits from master that need to be included in a future release.

@MylesBorins
Copy link
Contributor Author

@refack independent of the specific reading of the text this is how the LTS team has operated... otherwise there would be no need or an @nodejs/backporters team.

The only reason the branches are not protected are because they can't be force pushed

--> nodejs/Release#209

If we want to make the policy more lenient that is fine, but a different conversation. If the current way the policy is documented is confusing, we should fix that.

There have been more than one occasion where collaborators have accidentally backported stuff to the staging branch and it has been pointed out and not an issue. This is the first time it became clear that the documentation was inconsistent, or could be read as inconsistent, with how we actually do the work.

COLLABORATOR_GUIDE.md Outdated Show resolved Hide resolved
Copy link
Member

@Trott Trott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM in that this clearly documents our current practice and is more clear (I think) than the current text. Whether that practice could or should be changed, or whether the documentation could or should happen elsewhere rather than in this particular paragraph...
¯\(ツ)

Co-Authored-By: MylesBorins <myles.borins@gmail.com>
@targos
Copy link
Member

targos commented Nov 18, 2018

Then can this also mention the backporters team for LTS staging? I didn't know it's purpose until now

COLLABORATOR_GUIDE.md Outdated Show resolved Hide resolved
@MylesBorins
Copy link
Contributor Author

I've further clarified the language PTAL

@richardlau
Copy link
Member

@targos I'm trying to figure out the intention of the original language as compared to what is documented in https://github.com/nodejs/release#lts-staging-branches

Perhaps it is better to just point at the Release repo as the source of truth?

IMO https://github.com/nodejs/release#lts-staging-branches has the same issue as the collaborator guide before the changes in this PR:

Every LTS major version has two branches in the GitHub repository: a release branch and a staging branch. The release branch is used to cut new releases. Only members of the release team should land commits into the release branch. The staging branch is used to land cherry-picked or backported commits from master that need to be included in a future release.

So having defined "release branch" and "staging branch" the only documented restriction is on the "release branch" -- If both branches are to be restricted then why specify "release branch" in the third sentence?

@MylesBorins
Copy link
Contributor Author

can we fast track this?

@richardlau nodejs/Release#387 should fix the inconsistency in the Relase repo and I've opened nodejs/Release#388 to discuss changing the policy

team should land commits into the LTS branch while preparing a new
LTS release.
Only the members of the @nodejs/backporters team should land commits into the
LTS staging branch.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

into LTS staging branches.

Copy link
Member

@mhdawson mhdawson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM as documenting current practice

Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@MylesBorins
Copy link
Contributor Author

@danbev
Copy link
Contributor

danbev commented Nov 22, 2018

Landed in e9545e6.

@danbev danbev closed this Nov 22, 2018
danbev pushed a commit that referenced this pull request Nov 22, 2018
Current language is a bit confusing

PR-URL: #24465
Refs: #24344 (comment)
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
targos pushed a commit that referenced this pull request Nov 24, 2018
Current language is a bit confusing

PR-URL: #24465
Refs: #24344 (comment)
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
rvagg pushed a commit that referenced this pull request Nov 28, 2018
Current language is a bit confusing

PR-URL: #24465
Refs: #24344 (comment)
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
@BridgeAR BridgeAR mentioned this pull request Dec 5, 2018
4 tasks
codebytere pushed a commit that referenced this pull request Jan 13, 2019
Current language is a bit confusing

PR-URL: #24465
Refs: #24344 (comment)
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
refack pushed a commit to refack/node that referenced this pull request Jan 14, 2019
Current language is a bit confusing

PR-URL: nodejs#24465
Refs: nodejs#24344 (comment)
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
@codebytere codebytere mentioned this pull request Jan 15, 2019
codebytere pushed a commit that referenced this pull request Jan 29, 2019
Current language is a bit confusing

PR-URL: #24465
Refs: #24344 (comment)
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
codebytere pushed a commit that referenced this pull request Jan 29, 2019
Current language is a bit confusing

PR-URL: #24465
Refs: #24344 (comment)
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.