Merge pull request #216 from dpshelio/git-updates

Sets merge commit as default when pulling, and other branching changes

Author: ageorgou

ch02git/01Intro.ipynb

@@ -387,6 +387,30 @@
     "git config --global user.email \"[email protected]\""
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Additionally, it's also a good idea to define what's the name of the default branch when we create a repository:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%%bash\n",
+    "git config --global init.defaultBranch main"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Historically, the default branch was named `master`. Nowadays, the community and most of the hosting sites have changed the default ([read about this change in GitHub](https://github.com/github/renaming/) and [Gitlab](https://about.gitlab.com/blog/2021/03/10/new-git-default-branch-name/)."
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},

ch02git/04Publishing.ipynb

@@ -144,7 +144,7 @@
    ],
    "source": [
     "%%bash\n",
-    "git push -uf origin master # I have an extra `f` switch here.\n",
+    "git push -uf origin main # I have an extra `f` switch here.\n",
     "      #You should copy the instructions from YOUR repository."
    ]
   },

ch02git/05Collaboration.ipynb

@@ -512,7 +512,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Do as it suggests:"
+    "Do as it suggests. However, we need first to tell git how we want it to act when there are diverging branches (as in this case). We will set the default to be to create a merge commit, then we proceed to `pull`."
    ]
   },
   {
@@ -547,6 +547,7 @@
    ],
    "source": [
     "%%bash\n",
+    "git config --global pull.rebase false\n",
     "git pull"
    ]
   },

ch02git/06ForkAndPull.ipynb

@@ -95,7 +95,7 @@
     "It's a good practice to create a new branch that'll contain the changes we want. We'll learn more about branches later on. For now, just think of this as a separate area where our changes will be kept not to interfere with other people's work.\n",
     "\n",
     "```\n",
-    "git checkout -b southwest\n",
+    "git switch -c southwest\n",
     "```"
    ]
   },
@@ -209,7 +209,7 @@
     "\n",
     "* Numpy's example is only illustrative. Normally, Open Source projects have in their documentation (sometimes in the form of a wiki) a set of instructions you need to follow if you want to contribute to their software.\n",
     "\n",
-    "* Pull Requests can also be done for merging branches in a non-forked repository. It's typically used in teams to merge code from a branch into the master branch and ask team colleagues for code reviews before merging.\n",
+    "* Pull Requests can also be done for merging branches in a non-forked repository. It's typically used in teams to merge code from a branch into the `main` branch and ask team colleagues for code reviews before merging.\n",
     "\n",
     "* It's a good practice before starting a fork and a pull request to have a look at existing forks and pull requests. On GitHub, you can find the list of pull requests on the horizontal menu on the top of the page. Try to also find the network graph displaying all existing forks of a repo, e.g., [NumpyDoc repo's network graph](https://github.com/numpy/numpydoc/network)."
    ]

ch02git/10Branches.ipynb

@@ -79,7 +79,7 @@
    ],
    "source": [
     "%%bash\n",
-    "git checkout -b experiment # Make a new branch"
+    "git switch -c experiment # Make a new branch (use instead `checkout -b` if you have a version of git older than 2.23)"
    ]
   },
   {
@@ -180,7 +180,7 @@
    ],
    "source": [
     "%%bash\n",
-    "git checkout master # Switch to an existing branch"
+    "git switch main # Switch to an existing branch (use `checkout` if you are using git older than 2.23)"
    ]
   },
   {
@@ -233,7 +233,7 @@
    ],
    "source": [
     "%%bash\n",
-    "git checkout experiment"
+    "git switch experiment"
    ]
   },
   {
@@ -325,7 +325,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "If others checkout your repository, they will be able to do `git checkout experiment` to see your branch content,\n",
+    "If others checkout your repository, they will be able to do `git switch experiment` to see your branch content,\n",
     "and collaborate with you **in the branch**."
    ]
   },
@@ -410,7 +410,7 @@
    "outputs": [],
    "source": [
     "%%bash\n",
-    "git log master..experiment"
+    "git log main..experiment"
    ]
   },
   {
@@ -525,7 +525,7 @@
    ],
    "source": [
     "%%bash\n",
-    "git checkout master"
+    "git switch main"
    ]
   },
   {
@@ -612,7 +612,7 @@
    ],
    "source": [
     "%%bash\n",
-    "git commit -am \"Commit Aonach onto master branch\""
+    "git commit -am \"Commit Aonach onto main branch\""
    ]
   },
   {
@@ -642,7 +642,7 @@
    ],
    "source": [
     "%%bash\n",
-    "git log --left-right --oneline master...experiment"
+    "git log --left-right --oneline main...experiment"
    ]
   },
   {
@@ -877,11 +877,11 @@
    "source": [
     "### A good branch strategy\n",
     "\n",
-    "* A `production` branch: code used for active work\n",
-    "* A `develop` branch: for general new code\n",
-    "* `feature` branches: for specific new ideas\n",
-    "* `release` branches: when you share code with others\n",
-    "  * Useful for isolated bug fixes"
+    "* A `develop` or `main` branch: for general new code - (the cutting edge version of your software)\n",
+    "* `feature` branches: for specific new ideas. Normally branched out from `main`.\n",
+    "* `release` branches: when you share code with users. A particular moment of the `develop` process that it's considered stable.\n",
+    "  * Useful for including security and bug patches once it's been released.\n",
+    "* A `production` branch: code used for active work. Normally it's the same than the latest release."
    ]
   },
   {
@@ -914,10 +914,10 @@
    "metadata": {},
    "source": [
     "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.\n",
-    "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 `master` branch), you can do that with:\n",
+    "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:\n",
     "\n",
     "```\n",
-    "git checkout master test_file\n",
+    "git checkout main test_file\n",
     "```\n",
     "\n",
     "Using `git checkout` with a path takes the content of files.\n",

ch02git/11Miscellany.ipynb

@@ -796,7 +796,7 @@
    "source": [
     "%%bash\n",
     "\n",
-    "git checkout -b gh-pages\n",
+    "git switch -c gh-pages\n",
     "git push -uf origin gh-pages"
    ]
   },

ch02git/12Remotes.ipynb

@@ -97,7 +97,7 @@
    ],
    "source": [
     "%%bash\n",
-    "git checkout master\n",
+    "git switch main\n",
     "git remote add rits [email protected]:ucl-rits/github-example.git\n",
     "git remote -v"
    ]
@@ -189,7 +189,7 @@
    ],
    "source": [
     "%%bash\n",
-    "git push -uf rits master"
+    "git push -uf rits main"
    ]
   },
   {
@@ -231,7 +231,7 @@
    "source": [
     "%%bash\n",
     "git fetch\n",
-    "git log --oneline --left-right rits/master...origin/master"
+    "git log --oneline --left-right rits/main...origin/main"
    ]
   },
   {
@@ -264,7 +264,7 @@
    ],
    "source": [
     "%%bash\n",
-    "git diff --name-only origin/master"
+    "git diff --name-only origin/main"
    ]
   },
   {
@@ -415,7 +415,7 @@
    "source": [
     "%%bash\n",
     "git remote add local_bare ../bare_repo\n",
-    "git push -u local_bare master"
+    "git push -u local_bare main"
    ]
   },
   {
@@ -474,7 +474,7 @@
     "git init --bare\n",
     "exit\n",
     "git remote add <somename> ssh://user@host/mygitserver\n",
-    "git push -u <somename> master\n",
+    "git push -u <somename> main\n",
     "```"
    ]
   },

ch02git/13Rebase.ipynb

@@ -20,7 +20,7 @@
     "\n",
     "### An example rebase\n",
     "\n",
-    "We've built a repository to help visualise the difference between a merge and a rebase, at https://github.com/UCL-RITS/wocky_rebase/blob/master/wocky.md ."
+    "We've built a [repository to help visualise the difference between a merge and a rebase](https://github.com/UCL-RITS/wocky_rebase/blob/main/wocky.md)."
    ]
   },
   {
@@ -39,7 +39,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "On the master branch, a second commit ('Dancing') has been added:"
+    "On the `main` branch, a second commit ('Dancing') has been added:"
    ]
   },
   {
@@ -77,7 +77,7 @@
    "metadata": {},
    "source": [
     "```bash\n",
-    "git log --oneline --graph master\n",
+    "git log --oneline --graph main\n",
     "```\n",
     "\n",
     "```\n",
@@ -99,7 +99,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "If we now **merge** carollian into master, the final state will include both changes:"
+    "If we now **merge** carollian into main, the final state will include both changes:"
    ]
   },
   {
@@ -129,7 +129,7 @@
     "```\n",
     "\n",
     "```\n",
-    "*   b41f869 Merge branch 'carollian' into master_merge_carollian\n",
+    "*   b41f869 Merge branch 'carollian' into main_merge_carollian\n",
     "|\\\n",
     "| * 2232bf3 Translate into Caroll's language\n",
     "* | 2a74d89 Dancing\n",
@@ -150,7 +150,7 @@
    "metadata": {},
    "source": [
     "``` bash\n",
-    "git log --oneline --graph master_rebase_carollian\n",
+    "git log --oneline --graph main_rebase_carollian\n",
     "```\n",
     "\n",
     "```\n",
@@ -169,7 +169,7 @@
     "To trigger the rebase, we did:\n",
     "    \n",
     "``` bash\n",
-    "git checkout master\n",
+    "git switch main\n",
     "git rebase carollian\n",
     "```\n",
     "\n",
@@ -190,8 +190,8 @@
     "we get:\n",
     "\n",
     "```bash\n",
-    "git checkout carollian\n",
-    "git merge master\n",
+    "git switch carollian\n",
+    "git merge main\n",
     "```\n",
     "\n",
     "\n",
@@ -202,7 +202,7 @@
     " 1 file changed, 1 insertion(+)\n",
     "```\n",
     "\n",
-    "The master branch was already **rebased on** the carollian branch, so this merge was just a question of updating *metadata* (moving the label for the carollian branch so that it points to the same commit master does): a \"fast forward\".\n",
+    "The main branch was already **rebased on** the carollian branch, so this merge was just a question of updating *metadata* (moving the label for the carollian branch so that it points to the same commit main does): a \"fast forward\".\n",
     "\n",
     "### Rebasing pros and cons\n",
     "\n",

ch02git/14Bisect.ipynb

@@ -235,8 +235,8 @@
     "%%bash\n",
     "git bisect start\n",
     "git bisect bad # We know the current state is broken\n",
-    "git checkout master\n",
-    "git bisect good # We know the master branch state is OK"
+    "git switch main\n",
+    "git bisect good # We know the main branch state is OK"
    ]
   },
   {
@@ -440,7 +440,7 @@
     "%%bash\n",
     "git bisect start\n",
     "git bisect bad HEAD # We know the current state is broken\n",
-    "git bisect good master # We know master is good\n",
+    "git bisect good main # We know main is good\n",
     "git bisect run python squares.py 2 &> gitbisect.out\n",
     "cat gitbisect.out"
    ]