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: enforce strict policy to semver-major releases #55732

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

RafaelGSS
Copy link
Member

Refs: nodejs/Release#1054

This needs to be discussed first by the @nodejs/releasers. However, since the next session (nodejs/TSC#1648) might not happen due to NodeConf/Collab Summit I thought would be better to discuss it async.

cc: @nodejs/releasers @BethGriggs

@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/tsc

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Nov 5, 2024
@RafaelGSS RafaelGSS added the notable-change PRs with changes that should be highlighted in changelogs. label Nov 5, 2024
Copy link
Contributor

github-actions bot commented Nov 5, 2024

The notable-change PRs with changes that should be highlighted in changelogs. label has been added by @RafaelGSS.

Please suggest a text for the release notes if you'd like to include a more detailed summary, then proceed to update the PR description with the text or a link to the notable change suggested text comment. Otherwise, the commit will be placed in the Other Notable Changes section.

@RafaelGSS RafaelGSS added the blocked PRs that are blocked by other issues or PRs. label Nov 5, 2024
@RafaelGSS
Copy link
Member Author

Adding blocked label to make sure we will land it only when we get releasers consensus.

Copy link
Contributor

@aduh95 aduh95 left a comment

Choose a reason for hiding this comment

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

As is, it's wrong to say this PR enforces the strict policy, the commit message is a bit misleading. You could say "clarify", or maybe "stiffen".

IMO, this should either go in the collaborator-guibe.md document (if we expect non-releasers to comply with that policy), and/or the collaborator guide should forbid non-releasers to land semver-major PRs (I don't think we want to do that). If we want the policy to be enforced, the CQ should probably be updated to skip semver-major PRs until the branch-off.

@RafaelGSS
Copy link
Member Author

RafaelGSS commented Nov 5, 2024

I think landing a semver-major PR on main days/weeks before the semver-major release is ok. It doesn't mean that the commit will be included in the major release. My goal with this doc change is to clarify/enforce that the last sync between main and vN.x will be a month prior to the release. I might be using the wrong word, but I do think "enforce" should mean we won't include any semver-major PR that was merged into main less than a month of the release date (except in specific situations as mentioned in the doc too)

Comment on lines +1220 to +1222
No `SEMVER-MAJOR` pull requests should be landed within one month prior to
the major release date, unless there is consensus from the Node.js releasers
team to do so. This measure aims to ensure better stability for the release
Copy link
Contributor

@aduh95 aduh95 Nov 5, 2024

Choose a reason for hiding this comment

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

Oh I didn't read it like that, so you mean like the following?

Suggested change
No `SEMVER-MAJOR` pull requests should be landed within one month prior to
the major release date, unless there is consensus from the Node.js releasers
team to do so. This measure aims to ensure better stability for the release
If a `SEMVER-MAJOR` pull requests lands on the default branch within one month prior to
the major release date, it must not be included on the new major staging branch, unless there is consensus from the Node.js releasers
team to do so. This measure aims to ensure better stability for the release

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked PRs that are blocked by other issues or PRs. doc Issues and PRs related to the documentations. notable-change PRs with changes that should be highlighted in changelogs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants