Jump to content

User:Wctaiwan/Gerrit cheatsheet

From mediawiki.org

Cloning an extension[edit]

git clone ssh://username@gerrit.wikimedia.org:29418/mediawiki/extensions/MassMessage.git

Creating a new patchset[edit]

Creating a new branch[edit]

git checkout -b branch_name

This creates a branch called branch_name and switches to it. Note that this can be done at any point before commit (i.e. if you accidentally make changes on the master branch, just run git checkout -b new_branch and commit on that).

Committing changes[edit]

git add .
git commit

This adds all changed files to the staging area and commits the changes. You can also specify file names in place of . to commit specific changed files.

Uploading the patchset to gerrit[edit]

git review

Testing / updating an existing patchset[edit]

Downloading a patchset from gerrit[edit]

git review -d 31337

This downloads the contents of https://gerrit.wikimedia.org/r/31337/, puts them in a new branch, and switches to the branch.

Updating a patchset[edit]

git add .
git commit --amend

This amends the latest commit (i.e. the one containing the patchset) to include all of the changes you have made.

Rebasing a patchset on master[edit]

First, try clicking "Rebase" in gerrit. If that fails, make sure everything is committed, and then run

git checkout master
git pull
git checkout branch_name
git rebase master

Follow the on-screen instructions.

Uploading the updated patchset to gerrit[edit]

git review

General commands[edit]

Switching between branches[edit]

git checkout branch_name

Bringing a branch up to date with the remote[edit]

git pull

In general, it's a good idea to run git pull before making changes so that you're always working on top of the latest copy.

Note: This command does not work for downloading new versions of a gerrit patchset. For this use case, it's probably easiest to just run git review -d <number> where <number> is the gerrit change number to download the patchset to a new branch, and work on that instead. Note that if you have previously used git review -d to download a patchset and made changes to it, but have not uploaded the changes to gerrit, running the command again would destroy all local changes, so you should first use git checkout -b branch_name to copy the local changes to a new branch if you want to preserve them.

Viewing the status of a branch[edit]

git status

Viewing the commit log for a branch[edit]

git log

Press 'q' to back out of this view.

Dangerous commands[edit]

Discarding changes to a file since the last commit[edit]

git checkout file_name

Discarding all changes since the last commit[edit]

git reset --hard

Deleting a branch[edit]

git branch -D branch_name

Setting up tab completion for git commands[edit]