Branches¶

NOTE: using bash/git commands is not fully supported on jupyterlite yet (due to single thread/process restriction), and the cells below might error out on the browser (jupyterlite) version of this notebook

Branches are incredibly important to why git is cool and powerful.

They are an easy and cheap way of making a second version of your software, which you work on in parallel, and pull in your changes when you are ready.

In [1]:

import os
top_dir = os.getcwd()
git_dir = os.path.join(top_dir, 'learning_git')
working_dir = os.path.join(git_dir, 'git_example')
os.chdir(working_dir)

In [2]:

%%bash
git branch # Tell me what branches exist

* main

In [3]:

%%bash
git switch -c experiment # Make a new branch (use instead `checkout -b` if you have a version of git older than 2.23)

Switched to a new branch 'experiment'

In [4]:

%%bash
git branch

* experiment

  main

In [5]:

%%writefile Wales.md
Mountains In Wales
==================

* Pen y Fan
* Tryfan
* Snowdon
* Glyder Fawr
* Fan y Big
* Cadair Idris

Overwriting Wales.md

In [6]:

%%bash
git add Wales.md
git commit -m "Add Cadair Idris"

[experiment c2f8b93] Add Cadair Idris

 1 file changed, 1 insertion(+)

In [7]:

%%bash
git switch main # Switch to an existing branch (use `checkout` if you are using git older than 2.23)

Switched to branch 'main'

Your branch is up to date with 'origin/main'.

In [8]:

%%bash
cat Wales.md

Mountains In Wales

==================

* Pen y Fan

* Tryfan

* Snowdon

* Glyder Fawr

* Fan y Big

In [9]:

%%bash
git switch experiment

Switched to branch 'experiment'

In [10]:

cat Wales.md

Mountains In Wales
==================

* Pen y Fan
* Tryfan
* Snowdon
* Glyder Fawr
* Fan y Big
* Cadair Idris

Publishing branches¶

To let the server know there's a new branch use:

In [11]:

%%bash
git push -u origin experiment

remote:

remote: Create a pull request for 'experiment' on GitHub by visiting:

remote:      https://github.com/UCL/github-example/pull/new/experiment

remote:

To github.com:UCL/github-example.git

 * [new branch]      experiment -> experiment

branch 'experiment' set up to track 'origin/experiment'.

We use --set-upstream origin (Abbreviation -u) to tell git that this branch should be pushed to and pulled from origin per default.

If you are following along, you should be able to see your branch in the list of branches in GitHub.

Once you've used git push -u once, you can push new changes to the branch with just a git push.

If others checkout your repository, they will be able to do git switch experiment to see your branch content, and collaborate with you in the branch.

In [12]:

%%bash
git branch -r

  origin/experiment

  origin/gh-pages

  origin/main

Local branches can be, but do not have to be, connected to remote branches They are said to "track" remote branches. push -u sets up the tracking relationship. You can see the remote branch for each of your local branches if you ask for "verbose" output from git branch:

In [13]:

%%bash
git branch -vv

* experiment c2f8b93 [origin/experiment] Add Cadair Idris

  main       3ab4e05 [origin/main] Merge branch 'main' of github.com:UCL/github-example

Find out what is on a branch¶

In addition to using git diff to compare to the state of a branch, you can use git log to look at lists of commits which are in a branch and haven't been merged yet.

In [14]:

%%bash
git log main..experiment

commit c2f8b936b43fc9f6a3f4b2945c4b0a05abaef82b

Author: Lancelot the Brave <l.brave@spamalot.uk>

Date:   Fri Oct 11 16:38:53 2024 +0000

    Add Cadair Idris

Git uses various symbols to refer to sets of commits. The double dot A..B means "ancestor of B and not ancestor of A"

So in a purely linear sequence, it does what you'd expect.

In [15]:

%%bash
git log --graph --oneline HEAD~9..HEAD~5

*   d021e55 Merge branch 'main' of github.com:UCL/github-example

|\

| * 1b00743 Add Scotland

* | 8998c0c Add wales

|/

* a0867d8 Add Helvellyn

* c70de76 Include lakes in the scope

But in cases where a history has branches, the definition in terms of ancestors is important.

In [16]:

%%bash
git log --graph --oneline HEAD~5..HEAD

* c2f8b93 Add Cadair Idris

*   3ab4e05 Merge branch 'main' of github.com:UCL/github-example

|\

| * dd28cd4 Add another Beacon

* | 6f54574 Add Glyder

|/

*   d69bfab Merge branch 'main' of github.com:UCL/github-example

|\

| * a9af03a Add a beacon

* 954925f Translating from the Welsh

If there are changes on both sides, like this:

In [17]:

%%bash
git switch main

Switched to branch 'main'

Your branch is up to date with 'origin/main'.

In [18]:

%%writefile Scotland.md
Mountains In Scotland
==================

* Ben Eighe
* Cairngorm
* Aonach Eagach

Overwriting Scotland.md

In [19]:

%%bash
git diff Scotland.md

diff --git a/Scotland.md b/Scotland.md

index bd30092..bf5c643 100644

--- a/Scotland.md

+++ b/Scotland.md

@@ -2,5 +2,5 @@ Mountains In Scotland

 ==================

 * Ben Eighe

-* Ben Nevis

 * Cairngorm

+* Aonach Eagach

In [20]:

%%bash
git add Scotland.md
git commit -m "Commit Aonach onto main branch"

[main dd35065] Commit Aonach onto main branch

 1 file changed, 1 insertion(+), 1 deletion(-)

Then this notation is useful to show the content of what's on what branch:

In [21]:

%%bash
git log --left-right --oneline main...experiment

< dd35065 Commit Aonach onto main branch

> c2f8b93 Add Cadair Idris

Three dots means "everything which is not a common ancestor" of the two commits, i.e. the differences between them.

Merging branches¶

We can merge branches, and just as we would pull in remote changes, there may or may not be conflicts.

In [22]:

%%bash
git branch
git merge experiment

  experiment

* main

Merge made by the 'ort' strategy.

 Wales.md | 1 +

 1 file changed, 1 insertion(+)

In [23]:

%%bash
git log --graph --oneline HEAD~3..HEAD

*   303ede4 Merge branch 'experiment'

|\

| * c2f8b93 Add Cadair Idris

* | dd35065 Commit Aonach onto main branch

|/

* 3ab4e05 Merge branch 'main' of github.com:UCL/github-example

* dd28cd4 Add another Beacon

Cleaning up after a branch¶

In [24]:

%%bash
git branch

  experiment

* main

In [25]:

%%bash
git branch -d experiment

Deleted branch experiment (was c2f8b93).

In [26]:

%%bash
git branch

* main

In [27]:

%%bash
git branch --remote

  origin/experiment

  origin/gh-pages

  origin/main

In [28]:

%%bash
git push --delete origin experiment 
# Remove remote branch 
# - also can use github interface

To github.com:UCL/github-example.git

 - [deleted]         experiment

In [29]:

%%bash
git branch --remote

  origin/gh-pages

  origin/main

A good branch strategy¶

A develop or main branch: for general new code - (the cutting edge version of your software)
feature branches: for specific new ideas. Normally branched out from main.
release branches: when you share code with users. A particular moment of the develop process that it's considered stable.
- Useful for including security and bug patches once it's been released.
A production branch: code used for active work. Normally it's the same than the latest release.

Grab changes from a branch¶

Make some changes on one branch, switch back to another, and use:

git checkout <branch> <path>

to quickly grab a file from one branch into another. This will create a copy of the file as it exists in <branch> into your current branch, overwriting it if it already existed. For example, if you have been experimenting in a new branch but want to undo all your changes to a particular file (that is, restore the file to its version in the main branch), you can do that with:

git checkout main test_file

Using git checkout with a path takes the content of files. To grab the content of a specific commit from another branch, and apply it as a patch to your branch, use:

git cherry-pick <commit>