Rebasing your branch from the May 16, 2018 rebase - LlemonDuck/runelite GitHub Wiki

Introduction

Due to the rebase of the master branch on May 16, 2018 to follow Jagex's request, all branches will need to be rebased to the new code. If you forked RuneLite after May 16, 2018, you do not need to follow this guide.

Not many people are used to rebasing their branch on top of another rebased branch, which is why this was made.

Described below is the "git way" to rebase your branch. Alternatively, you may manually copy your work to a new fork of the most recent code base.

Assumptions

• You have followed the Beginner's Guide To Git.
• You have your branches already pushed to GitHub! If not, do so now.

Guide

The following process will delete all uncommitted and locally-staged work in your local project. You may wish to backup your local folder before doing this.

Updating upstream/master

First, reset the upstream master to the current version.

git fetch upstream
git checkout upstream/master
git reset --hard upstream/master

Updating our branch

Now it's time to update our branches.

git checkout my-awesome-feature

Run git log and COUNT the number of commits YOU made since the previous version of master. Typically you will see a "merge pull request" type of commit.

IF you have only one commit that you want rebased:

git rebase --onto upstream/master my-awesome-feature~ my-awesome-feature # notice the "~"

IF you have more than one commit that you want rebased:

git rebase --onto upstream/master my-awesome-feature~3 my-awesome-feature # rebase 3 commits on top of master

Testing

After running this, do a git log and check if the history looks good.

Now, make sure your rebase worked by actually testing it in RuneLite!

If it didn't go as planned, you can reset to what you have on your feature branch in GitHub by running git reset --hard origin/my-awesome-feature.

Pushing

If it did go well, it's time to force push your branch with git push --force. Now, if you look at your PR, it should be back to normal.

Cleaning up your local history

If you wish to remove all dangling branches after you're done rebasing all your pull requests, download this script and save it as git-branch-cleanup. Then, navigate to your repository and run

git checkout master
git-branch-cleanup -D

This info mostly came from a stackoverflow post.

If there are any mistakes, or a simpler method, please update this wiki!