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: remove outdated COLLABORATOR_GUIDE sentence about breaking changes #25780

Closed
wants to merge 1 commit into from

Conversation

Trott
Copy link
Member

@Trott Trott commented Jan 29, 2019

The TSC has delegated authority over LTS and Current branches to the
Release WG. Remove the bullet point about TSC having authority to
determine that a breaking change is necessary on LTS and Current release
branches. Retaining that authority would require de-chartering the
Release WG.

Fixes: nodejs/TSC#660

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

The TSC has delegated authority over LTS and Current branches to the
Release WG. Remove the bullet point about TSC having authority to
determine that a breaking change is necessary on LTS and Current release
branches. Retaining that authority would require de-chartering the
Release WG.

Fixes: nodejs/TSC#660
@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Jan 29, 2019
@Trott Trott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jan 29, 2019
Copy link
Member

@MylesBorins MylesBorins left a comment

Choose a reason for hiding this comment

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

LGTM

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.

I think a TSC and lts consensus is necessary in both cases. In other terms, a breaking change cannot land without notifying the TSC and lts.

@MylesBorins
Copy link
Member

@mcollina I think there is a subtle difference between what lands in master and what goes out in a release. The only time where a breaking change would land "directly" on a release line would be in the case of fixing a problem directly on the release. One example is security releases, which afaik have not relied on TSC sign off to push.

@Trott
Copy link
Member Author

Trott commented Jan 29, 2019

I think a TSC and lts consensus is necessary in both cases. In other terms, a breaking change cannot land without notifying the TSC and lts.

@mcollina True for master branch, but this bullet point is about what goes out in an LTS or Current release.

TSC (well, CTC, but that doesn't change anything) chartered the Release WG in nodejs/Release#223. In that chartering, responsibilities were delegated to Release WG. Specifically: "Define the content of releases." If we wish to change that now. we need to de-charter Release WG and re-charter with different responsibilities.

Also worth noting: This bullet point that's being removed is currently not even listed as necessary for a change. Any one of the three bullet points is sufficient. Therefore, removing this bullet point reduces the ways breaking changes can be introduced into LTS branches.

@@ -282,7 +282,6 @@ providing a Public API in such cases.
* Resolving critical security issues.
* Fixing a critical bug (e.g. fixing a memory leak) requires a breaking
change.
* There is TSC consensus that the change is required.
Copy link
Contributor

Choose a reason for hiding this comment

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

If the authority was delegated to the Release WG, then shouldn't this be s/TSC/Release WG/?

We have policies so that there is predictability and transparency to the decisions made by the responsible people, but those people ultimately have the right to break those policies, if as a group they decide its the right thing to do. The planned openssl 1.1.1 update in the 10.x release line for example best fits the bullet being removed here.

Copy link
Member Author

Choose a reason for hiding this comment

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

@sam-github Yes and no. I'd say it's a bigger change than that. All these bullet points should probably be replaced with a statement that what ends up in LTS/Current is up to Release WG, with a link to where Release WG documents their requirements. I'm doing things iteratively, though, because small and focused changes to this document seem to be things we can talk about and land, but big changes run a bigger risk of being stalled. (Not sure if that was my experience with this doc or elsewhere, but it's definitely A Thing.)

So my plan is: First, remove this bullet point because it's wrong. Then replace the remaining stuff with a link to Release WG material--probably https://github.com/nodejs/Release#release-plan but maybe there's something even better somewhere? And there may be other steps too. But those are the next two. :-D

@mcollina mcollina dismissed their stale review January 30, 2019 13:32

Understood, I'm not LGTM this change, but I would not object. I'm ok in having a distilled form of https://github.com/nodejs/Release#release-plan instead.

@Trott
Copy link
Member Author

Trott commented Jan 31, 2019

Landed in 43bba40

@Trott Trott closed this Jan 31, 2019
Trott added a commit to Trott/io.js that referenced this pull request Jan 31, 2019
The TSC has delegated authority over LTS and Current branches to the
Release WG. Remove the bullet point about TSC having authority to
determine that a breaking change is necessary on LTS and Current release
branches. Retaining that authority would require de-chartering the
Release WG.

Fixes: nodejs/TSC#660

PR-URL: nodejs#25780
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
addaleax pushed a commit that referenced this pull request Feb 1, 2019
The TSC has delegated authority over LTS and Current branches to the
Release WG. Remove the bullet point about TSC having authority to
determine that a breaking change is necessary on LTS and Current release
branches. Retaining that authority would require de-chartering the
Release WG.

Fixes: nodejs/TSC#660

PR-URL: #25780
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
@targos targos mentioned this pull request Feb 14, 2019
@Trott Trott deleted the remove-tsc-thing branch January 13, 2022 22:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clarifying breaking changes landing in Current or LTS
8 participants