Difference between revisions of "Branching"

From Geos-chem
Jump to: navigation, search
(Use Gitk to create a new branch)
(Create a new branch from the command line)
Line 40: Line 40:
 
  git checkout master
 
  git checkout master
  
Then type
+
If you are creating a new feature branch, then type:
  
  git branch feature/MyFeature
+
  git branch feature/NAME
  git checkout feature/MyFeature
+
  git checkout feature/NAME
  
Your new branch name should adhere to the [[Viewing_the_revision_history#Branches|Gitflow nomenclature]].
+
On the other hand, if you are creating a bugfix branch, then type:
 +
 
 +
git branch bugfix/NAME
 +
git checkout bugfix/NAME
 +
 
 +
where <tt>NAME</tt> is to be the name of the feature or bug fix that you are implementing.
  
 
--[[User:Bmy|Bob Yantosca]] ([[User talk:Bmy|talk]]) 15:25, 20 June 2019 (UTC)
 
--[[User:Bmy|Bob Yantosca]] ([[User talk:Bmy|talk]]) 15:25, 20 June 2019 (UTC)

Revision as of 15:40, 20 June 2019

Previous | Next | Guide to using Git with GEOS-Chem | Getting Started with GEOS-Chem | GEOS-Chem Main Page

Overview

On this page, we describe how to create new branches with Git.

Creating branches

There are several ways that you can create new branches with Git.

Use Git Gui to create a new branch

To create a new branch in the git gui, go to the Branch/Create on the menu bar (or type CTRL-N).

GitGuiBranchMenu.png

You will get a dialog box that prompts you for the new branch name.

GitGuiNewBranch.png

The current branch name is displayed at the top left of the Git GUI, and will also be highlighted in the Create New Branch menu. Your new branch will split off the currently checked-out branch.

In the Create New Branch dialog box, type a unique branch name and then click OK. Your new branch name should adhere to the Gitflow nomenclature. You will be automatically placed into the branch you have just created.

Use Gitk to create a new branch

You can also create a new branch very quickly from the Gitk browser. Right click on any commit, and then pick: Create new branch

GitkNewBranch.png

This will pop open a dialog box that asks you to pick the name of the new branch.

GitKCreateBranch.png

Your new branch name should adhere to the Gitflow nomenclature.

Create a new branch from the command line

First, check out the branch that you wish to branch off from. In this case, let's branch off master.

git checkout master

If you are creating a new feature branch, then type:

git branch feature/NAME
git checkout feature/NAME

On the other hand, if you are creating a bugfix branch, then type:

git branch bugfix/NAME
git checkout bugfix/NAME

where NAME is to be the name of the feature or bug fix that you are implementing.

--Bob Yantosca (talk) 15:25, 20 June 2019 (UTC)

Determining which branch is checked out

You can determine which branch you are on as follows:

Using this: Follow these steps:
Git GUI Look at the top left (under the Repository menu), and you will see the name the branch that is currently checked-out.
Gitk Look for the GREEN BOX with the boldfaced name inside. This indicates the branch that is currently checked-out.
The command line Type:
git branch

and you will see all of the branches:

 dev/12.4.0
*master

The branch that is currently checked-out will have an * in front of it.


Previous | Next | Guide to using Git with GEOS-Chem | Getting Started with GEOS-Chem | GEOS-Chem Main Page