Skip to content

doc: add triaging for lts releases guide - #20165

Closed
BethGriggs wants to merge 2 commits into
nodejs:masterfrom
BethGriggs:backporting-guide
Closed

doc: add triaging for lts releases guide#20165
BethGriggs wants to merge 2 commits into
nodejs:masterfrom
BethGriggs:backporting-guide

Conversation

@BethGriggs

@BethGriggsBethGriggs commented Apr 20, 2018

Copy link
Copy Markdown
Member

Adds info for backporting commits and PRs to LTS branches.

If we can get a guideline process agreed and written down, it should make it easier for more people to help out with the backporting.

//cc @gibfahn, @MylesBorins

Checklist

@nodejs-github-botnodejs-github-bot added the doc Issues and PRs related to the documentations. label Apr 20, 2018
@vsemozhetbyt

vsemozhetbyt commented Apr 20, 2018

Copy link
Copy Markdown
Contributor

How does this guide relate to the https://github.com/nodejs/node/blob/master/doc/guides/backporting-to-release-lines.md ?

@vsemozhetbytvsemozhetbyt added meta Issues and PRs related to the general management of the project. lts Issues and PRs related to Long Term Support releases. labels Apr 20, 2018
@richardlau

Copy link
Copy Markdown
Member

Are the mechanics of backporting to LTS different from backporting to current?

@MylesBorinsMylesBorins self-assigned this Apr 20, 2018
@MylesBorins

Copy link
Copy Markdown
Contributor

@vsemozhetbyt I'll review both documents and see if there is value in merging them or having different docs... might be good to have a separate one specifically about triaging.

@richardlau backporting to LTS is the same for external collaborators. Triaging and landing commits (backport and from release lines) is different.

@BethGriggs

Copy link
Copy Markdown
MemberAuthor

backporting-to-release-lines currently instructs contributors on how to open a backport PR, whereas this guide would document the process of landing the backport PRs/triaging commits to land. Initially I separated it out as I thought it may be confusing to show how to open a backport commit (applicable to any contributor) in the same place as how to land backport PRs/commits on staging branches (collaborator specific).

Perhaps any additional content should just be merged and expand the COLLABORATOR_GUIDE.md#technical-howto?

The main aim is to make it easier/clearer for any collaborator to traige and pull commits into the staging branches.

@BridgeAR

Copy link
Copy Markdown
Member

@nodejs/documentation PTAL

@BridgeAR

BridgeAR commented Apr 25, 2018

Copy link
Copy Markdown
Member

@BethGriggs is this still WIP? (Please use the labels for that by the way)

@BridgeARBridgeAR added the wip Issues and PRs that are still a work in progress. label Apr 25, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Should this be called "Creating a release" instead.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

+1 to preparing an LTS release or Triaging for LTS releases

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nit: shas -> SHAs or even SHA checksums or whatever the best word (instead of checksums) might be there (commit hashes?).

@BridgeAR

Copy link
Copy Markdown
Member

Closing due to no response. @BethGriggs please feel free to reopen / leave a comment in case you would like to work on this again or open a new PR.

@gibfahn

Copy link
Copy Markdown
Member

We really need this.

@gibfahngibfahn reopened this May 29, 2018
@jasnell

Copy link
Copy Markdown
Member

+1 to reopening... closing this was premature.

@BethGriggs

Copy link
Copy Markdown
MemberAuthor

I have been on vacation - planning to sync up with @MylesBorins this week to progress this guide.

@BethGriggs

Copy link
Copy Markdown
MemberAuthor

@MylesBorins, what do you think should happen to this guide based on discussions at the Berlin summit about a process change (e.g. about utilizing minor and patch branches from @BridgeAR)? Have we written that proposal down anywhere?

@gibfahn

Copy link
Copy Markdown
Member

@MylesBorins, what do you think should happen to this guide based on discussions at the Berlin summit about a process change (e.g. about utilizing minor and patch branches from @BridgeAR)?

Not Myles Borins 😁, but my preference would be to document the process as is, and then we can use the PR to update it with the new proposal to discuss how exactly that should work.

@MylesBorinsMylesBorins left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

So I've added some comments in line.

I'm curious, this guide mostly breaks down to a handful of git-fu. Perhaps it makes sense to make a separate git guide for core that includes aliases and techniques and focus on how to decide if a commit should land and branch-diff techniques for this guide?

Also open to landing all the things in here, but there is the risk of repeated information

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

+1 to preparing an LTS release or Triaging for LTS releases

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

can you explain --origin DANGER rather than upstream which is usually the convention I've seen used

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

That was a suggestion from @gibfahn for my setup - i'll swap it back to upstream so that it is consistent with other docs.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

i usually do git remote update -p

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

alternatively you can fix this manually while landing

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I've ended up removing --whitespace=fix as it can cause some serious issues with certain backports.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

sometimes I'll just run the tests for the PR in question when backporting rather than running all the tests

see: https://github.com/MylesBorins/dot-files/blob/master/.bash_profile#L64

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

branch-diff vX.x-staging upstream/vY.x -exclude-label semver-major,semver-minor,dont-land-on-vX.x,backport-requested-vX.x,backported-to-vX.x,baking-for-lts --filter-release

where X = LTS branch and Y = Current branch

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

$ branch-diff vX.x-staging upstream/master --exclude-label semver-major,dont-land-on-vX.x,backport-requested-vX.x,backported-to-vX.x --filter-release --format=sha --reverse > commits
$ cat commits | xargs git cherry-pick

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

this will only work when doing the above step

@BethGriggsBethGriggs changed the title [WIP] doc: add backporting to LTS branches guide[WIP] doc: add triaging for lts releases guideJun 8, 2018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'd say this should come at the top before the Triage PRs section potentially?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

For ease of understanding it might be helpful to add that this patch flow also applies to commits, and add a section to commit triaging that includes an example similar to:
$ git pa https://github.com/nodejs/node/commit/1a2b3c4d

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

nit: remove --whitespace=fix #

@BethGriggs
BethGriggsforce-pushed the backporting-guide branch 3 times, most recently from c1f78e3 to 3087c7dCompareOctober 9, 2018 10:36
Comment threaddoc/releases.md Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
Go through PRs with the label `vN.x`. e.g. [PRs with the v8.x label](https://github.com/nodejs/node/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc+label%3Av8.x).
Go through PRs with the label `vN.x`. e.g. [PRs with the `v8.x` label](https://github.com/nodejs/node/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc+label%3Av8.x).

@Trott

Trott commented Dec 4, 2018

Copy link
Copy Markdown
Member

BethGriggsand others added 2 commits December 4, 2018 18:27
@Trott

Trott commented Dec 5, 2018

Copy link
Copy Markdown
Member

@TrottTrott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 5, 2018
@Trott

Trott commented Dec 5, 2018

Copy link
Copy Markdown
Member

Landed in a845d7a

@TrottTrott closed this Dec 5, 2018
Trott pushed a commit to Trott/io.js that referenced this pull request Dec 5, 2018
Add a section on triaging commits and PRs to land in releases.
PR-URL: nodejs#20165
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
BridgeAR pushed a commit that referenced this pull request Dec 5, 2018
Add a section on triaging commits and PRs to land in releases.
PR-URL: #20165
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
@BridgeARBridgeAR mentioned this pull request Dec 5, 2018
4 tasks
BridgeAR pushed a commit that referenced this pull request Dec 7, 2018
Add a section on triaging commits and PRs to land in releases.
PR-URL: #20165
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
BridgeAR pushed a commit that referenced this pull request Dec 7, 2018
Add a section on triaging commits and PRs to land in releases.
PR-URL: #20165
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
refack pushed a commit to refack/node that referenced this pull request Jan 14, 2019
Add a section on triaging commits and PRs to land in releases.
PR-URL: nodejs#20165
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
BethGriggs added a commit that referenced this pull request Feb 12, 2019
Add a section on triaging commits and PRs to land in releases.
PR-URL: #20165
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
@BethGriggsBethGriggs mentioned this pull request Feb 12, 2019
BethGriggs added a commit that referenced this pull request Feb 20, 2019
Add a section on triaging commits and PRs to land in releases.
PR-URL: #20165
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
rvagg pushed a commit that referenced this pull request Feb 28, 2019
Add a section on triaging commits and PRs to land in releases.
PR-URL: #20165
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
@BethGriggs
BethGriggs deleted the backporting-guide branch June 11, 2019 18:09
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.docIssues and PRs related to the documentations.ltsIssues and PRs related to Long Term Support releases.metaIssues and PRs related to the general management of the project.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

14 participants

@BethGriggs@vsemozhetbyt@richardlau@MylesBorins@BridgeAR@gibfahn@jasnell@Trott@thefourtheye@codebytere@targos@gireeshpunathil@mhdawson@nodejs-github-bot