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: add policy for landing new npm releases #21594

Closed
wants to merge 2 commits into from

Conversation

MylesBorins
Copy link
Contributor

@MylesBorins MylesBorins commented Jun 29, 2018

This change in policy sets clear terms for when / how npm releases
can be landed into master and how long they are expected to bake in the
ecosystem. This is to cover all release types of npm including semver-major
releases.

What Node.js release streams the new version of npm land into are at the discretion of the
release team and not specified by this policy.

I would like to ensure that we have consensus in landing this from @nodejs/collaborators @nodejs/tsc @nodejs/release and @nodejs/npm

/cc @zkat @iarna @bcoe @ceejbot

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

@addaleax addaleax left a comment

Choose a reason for hiding this comment

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

The linter is failing, but pending that LGTM

@@ -1,5 +1,11 @@
# Maintaining npm in Node.js

New pull requests should be opened when a "next" release has been released.

Once the "next" release has been promoted to "latest" the PR should be updated as neccessary
Copy link
Contributor

@vsemozhetbyt vsemozhetbyt Jun 29, 2018

Choose a reason for hiding this comment

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

Nits:

  • neccessary -> necessary
  • Missing period.
  • Wrapping this and the next line at 80 chars.

@vsemozhetbyt vsemozhetbyt added the npm Issues and PRs related to the npm client dependency or the npm registry. label Jun 30, 2018
@zkat
Copy link
Contributor

zkat commented Jun 30, 2018

I'm gonna hold off on discussing this until Rebecca's back from PTO next week, but I'm enthusiastic about node having a more official policy about how we handle npm updates.

@TimothyGu
Copy link
Member

What Node.js release streams the new version of npm land into are at the discretion of the
release team and not specified by this policy.

I think this should be made clear in the document as well.

@zkat
Copy link
Contributor

zkat commented Jul 2, 2018

This seems fine. I'm not sure if you'll want to have a policy on hotfixes/regressions, but otherwise the timing's pretty much up to y'all.

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 would like to have some text on how npm releases are backported, and a couple of notes on when/how to land a semver-major change in NPM.

This change in policy sets clear terms for when / how npm releases
can be landed into master and how long they are expected to bake in the
ecosystem. This is to cover all release types of npm including semver-major
releases.

What Node.js releases the updates land into are at the discretion of the
release team.
@MylesBorins
Copy link
Contributor Author

Updated all the things. PTAL

@iarna
Copy link
Member

iarna commented Jul 9, 2018

As @zkat says, npm is happy to go along with whatever seems best for the Node.js project. With my Node.js contributor hat on, this seems quite reasonable and feels to me like a comfortable margin to assess the safety of updates.

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

@MylesBorins
Copy link
Contributor Author

@nodejs/collaborators @nodejs/tsc @nodejs/npm I plan to land this in 24 hours if there are no objections

assuming no major regressions are found. There are no additional constraints
for Semver-Major releases.

The specific Node.js release stream the new version will be able to land into
Copy link
Member

Choose a reason for hiding this comment

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

grammar nit: release streams … are?

@MylesBorins
Copy link
Contributor Author

Landed in 7570ad5 fixing above nit

MylesBorins added a commit that referenced this pull request Jul 13, 2018
This change in policy sets clear terms for when / how npm releases
can be landed into master and how long they are expected to bake in the
ecosystem. This is to cover all release types of npm including semver-major
releases.

What Node.js releases the updates land into are at the discretion of the
release team.

PR-URL: #21594
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
targos pushed a commit that referenced this pull request Jul 14, 2018
This change in policy sets clear terms for when / how npm releases
can be landed into master and how long they are expected to bake in the
ecosystem. This is to cover all release types of npm including semver-major
releases.

What Node.js releases the updates land into are at the discretion of the
release team.

PR-URL: #21594
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
@targos targos mentioned this pull request Jul 17, 2018
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. npm Issues and PRs related to the npm client dependency or the npm registry.
Projects
None yet
Development

Successfully merging this pull request may close these issues.