Skip to content

meta: note in backport guide about updating tree #16424

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.

Sign up for GitHub

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

Closed
vsemozhetbyt wants to merge 1 commit into from
Closed

meta: note in backport guide about updating tree #16424

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 13 additions & 10 deletions doc/guides/backporting-to-release-lines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,18 @@ release line. All commands will use the `v6.x-staging` branch as the target
branch. In order to submit a backport pull request to another branch, simply
replace that with the staging branch for the targeted release line.

1. Checkout the staging branch for the targeted release line
2. Make sure that the local staging branch is up to date with the remote
3. Create a new branch off of the staging branch
1. Update the tree if needed to have the backport source
2. Checkout the staging branch for the targeted release line
3. Make sure that the local staging branch is up to date with the remote
4. Create a new branch off of the staging branch

```shell
# Assuming your fork of Node.js is checked out in $NODE_DIR,
# the origin remote points to your fork, and the upstream remote points
# to git://github.com/nodejs/node
cd $NODE_DIR
# Update the tree if needed
git checkout master && git fetch upstream && git merge --ff-only upstream/master
# If v6.x-staging is checked out `pull` should be used instead of `fetch`
git fetch upstream v6.x-staging:v6.x-staging -f
# Assume we want to backport PR #10157
Expand All @@ -51,7 +54,7 @@ git checkout -b backport-10157-to-v6.x v6.x-staging
git clean -xfd ./test/
```

4. After creating the branch, apply the changes to the branch. The cherry-pick
5. After creating the branch, apply the changes to the branch. The cherry-pick
will likely fail due to conflicts. In that case, you will see something
like this:

Expand All @@ -64,14 +67,14 @@ hint: with 'git add <paths>' or 'git rm <paths>'
hint: and commit the result with 'git commit'
```

5. Make the required changes to remove the conflicts, add the files to the index
6. Make the required changes to remove the conflicts, add the files to the index
using `git add`, and then commit the changes. That can be done with
`git cherry-pick --continue`.
6. Leave the commit message as is. If you think it should be modified, comment
7. Leave the commit message as is. If you think it should be modified, comment
in the Pull Request.
7. Make sure `make -j4 test` passes.
8. Push the changes to your fork
9. Open a pull request:
8. Make sure `make -j4 test` passes.
9. Push the changes to your fork
10. Open a pull request:
1. Be sure to target the `v6.x-staging` branch in the pull request.
2. Include the backport target in the pull request title in the following
format — `[v6.x backport] <commit title>`.
Expand All @@ -80,7 +83,7 @@ hint: and commit the result with 'git commit'
4. In the description add a reference to the original PR
5. Run a [`node-test-pull-request`][] CI job (with `REBASE_ONTO` set to the
default `<pr base branch>`)
10. If during the review process conflicts arise, use the following to rebase:
11. If during the review process conflicts arise, use the following to rebase:
`git pull --rebase upstream v6.x-staging`

After the PR lands replace the `backport-requested-v6.x` label on the original
Expand Down