using git inside eclipse, pushing/cloning from github

Java for HydrologistsSome useful applications of EGit

R. Rigon, F. Serafin

March 20, 2014

Introduction Push new local project on remote Clone remote repo in your local Push modifies of cloned project

Objectives

Some useful applications of EGit1

• Introduction to EGit and installation into Eclipse;• Load local existing project into remote GitHub repository;• Clone remote project into local repository.

1All the instructions are taken from Lars Vogel’s bloghttp://www.vogella.com/tutorials/EclipseGit/article.htmland from Eclipsepedia https://wiki.eclipse.org/EGit/User_Guide.

Riccardo Rigon, Francesco SerafinMarch 20, 2014 2 / 48

Objectives

For the complete guide visithttp://www.vogella.com/tutorials/EclipseGit/article.htmlhttps://wiki.eclipse.org/EGit/User_Guide

Git and GitHub

What is Git?

In software development, Git is a distributed revision control and source codemanagement system2.

2Git was initially designed and developed by Linus Torvalds for Linux kernel development

Git and GitHub

What is Git?

Distributed revision controlIn computer programming, a distributed revision control system (DRCS) ordistributed version control system (DVCS) keeps track of software revisions andallows many developers to work on a given project without requiring that theymaintain a connection to a common network.

Git and GitHub

What is Git?

Distributed revision controlIn computer programming, a distributed revision control system (DRCS) ordistributed version control system (DVCS) keeps track of software revisions andallows many developers to work on a given project without requiring that theymaintain a connection to a common network.

Every Git working directory is a full-fledged repository with complete historyand full version tracking capabilities, not dependent on network access or acentral server.

Git and GitHub

What is GitHub?

GitHub is a web-based hosting service for software development projects thatuse the Git revision control system. GitHub offers both paid plans for privaterepositories, and free accounts for open source projects.

Git and GitHub

What is GitHub?

GitHub is a web-based hosting service for software development projects thatuse the Git revision control system. GitHub offers both paid plans for privaterepositories, and free accounts for open source projects.

The site provides social networkingfunctionality such as feeds, followers,wikis and the social network graph todisplay how developers work on theirversions of a repository.

What is EGit

What is EGit?

EGit is an Eclipse plug-in which allows you to use the distributed versioncontrol system Git directly within the Eclipse IDE.

EGit is based on the JGit library.

What is EGit

What is EGit?

EGit is an Eclipse plug-in which allows you to use the distributed versioncontrol system Git directly within the Eclipse IDE.

EGit is based on the JGit library.

JGitJGit is a library which implements the Gitfunctionality in Java

Installation of Git into Eclipse

Installation of EGit

The EGit plug-in can be installed into every Eclipse IDE installation.

Most Eclipse 4.2 and Eclipse 4.3 downloads from Eclipse.org contain EGit intheir default configuration

No additional installation is required

If the EGit plug-in is missing in your Eclipse installation, you can install it viathe Eclipse Marketplace. Start this manager via the Help→EclipseMarketplace menu entry.

Eclipse Marketplace

The dialog to install EGit is depicted in the following screenshot.

Eclipse Marketplace

The dialog to install EGit is depicted in the following screenshot.

Setting up Git in Eclipse

Eclipse preferences

Before using EGit you should:• create a folder where store the projects you want to load on GitHub (theGit default repository folder);

• configure your name used in Git;• configure your email address used in Git3;• configure your Git default repository folder.

3Git configuration settings can be configured using the EGit configuration preference pagebut this configuration is not store in the Eclipse preferences store but in git configuration filesin order to ensure that native git sees the same configuration.

Eclipse preferences

The Eclipse Git functionality allows you to configure your default user andemail address for a commit. SelectWindow→Preferences→Team→Git→Configuration to set them up.

Set up name and email used in Git

You can add entries to your Git configuration by pressing the Add Entry buttonon the Git Configuration preference page.

Set up name and email used in Git

You can add entries to your Git configuration by pressing the Add Entry buttonon the Git Configuration preference page.

Set up name used in Git

To add your user, use the user.name as key and your real name as value.

Set up mail used in Git

Repeat the procedure for your email address, using user.email as key as shownbelow.

Set up Git default repository folder

You can also enter the default folder for storing Git repositories via theWindow→Preferences→Team→Git and writing the correct path in DefaultRepository Folder entry.

Set up Git default repository folder

You can also enter the default folder for storing Git repositories via theWindow→Preferences→Team→Git and writing the correct path in DefaultRepository Folder entry.

Create the Project

New Java Project

Create a new Java project (we will work with a simple Hello World code).

• Right click in the white space ofthe Package Explorer, after clickon New→Java Project;

• In the Dialog that appeared,remove the tick in Use defaultlocation;

• Click on Browse, in the Dialogthat appeared enter in your Gitdefault repository folder and createa new folder namedJavaForHydrologists.example.Enter in the new folder and clickOK.

• Thus Eclipse automatically setsthe Folder Name like ProjectName. Then click Finish.

Create the Project

New Java Project

Create the Project

New Java Project

Create the Project

New Java Project

Create the Project

New Java Project

Create the Project

New Java Project

Create the Project

New Java Project

Create the Project

Hello World!

Now write a simple Hello World code in the newly created project.

Create the Project

Hello World!

You must:• Create a new package;• Create a new class;• Write the code.

Create the Project

Hello World!

Create the Project

Hello World!

Create the Project

Hello World!

Create the Project

Hello World!

Once you have wrote the code, we are going to create a local Git Repository.

Create local Git Repository

Git Repositories view

First we need to view the Git Repositories present in our Git default repository.

• Click onWindow→Show View→Other ;

• In the Show view Dialog, expandGit and click on Git Repositories.Then click OK;

• Now you can see the GitRepositories tab in your EclipseIDE.

Share the Java Project

To create a new Git local Repository, we have to share the existing project.

• Right click on theJavaForydrologists.example projectand then click to Team→ShareProject;

• Select the repository type Git andclick Next;

• To configure the Git repositoryselect Use or create repository inparent folder of project;

• In the next Dialog select theproject and click to CreateRepository, after click Finish;

But the decorator text “[NO-HEAD]” behind the project shows that this projectis not tracked in a repository and the question mark decorators show that the.classpath, .project, the .settings files and the src content are not yet under versioncontrol.

Create a remote repository on GitHub

Go to www.github.com and log in with your credentials. In your home clicklike below.

Repository name: JavaFor Hydrologists.example

Description of the repository: First GitHub repository to use with EGit

Click to Create repository

After creation of your new repository, GitHub displays the information aboutwhat you have to do if you want to connetc to this repository via the commandline.

As we are going to use EGit you can ignore this information, but don’t closethe window because we need the SSH or HTTP link.

Set Remote in local repository

Create Remote

Now we have the link indispensable to establish the connection between localand remote repository. Thus, in Eclipse in the Git Repositories tab, expand theJavaForHydrologists.example and right click on Remote and then CreateRemote.

Create Remote

• In the open Dialog the Remotename must be origin, then clickOK;

• To Configure Push, in the nextDialog click on Change;

• From your Git Remote Repository,copy the https link and paste it inthe URI space. Eclipseautomatically will fill the otherfileds

• After you must only write yourGitHub credentials and the click toFinish.

Create Remote

Basic operations in EGit

Basic operations

So we can prepare our local repository to push it to remote repository. Themost important operations are described below. Right click on the project inthe Package Explorer at every step:

• Team→Add to indexto add the selected resource(s) to the

index of Git

• Team→Committo open the commit dialog for

committing to your Git repository

Then click Commit• Team→Push branch

only for the first time, beacuse you mustcreate the first master branch

• In this Dialog there is nothing todo, click Next

• Insert your credentials of GitHub

• In this Dialog click Finish• After push, click OK

Basic operations

index of Git

Basic operations

index of Git

Basic operations

index of Git

Basic operations

index of Git

Basic operations

index of Git

Basic operations

index of Git

Basic operations

index of Git

Basic operations

index of Git

Basic operations

index of Git

Summary of the main steps

Our local repository is been now copied on remote repository.

But once you have create the first master branch, to push your modify youneed follow this basic sequence:

• Team→Add to index• Team→Commit• Team→Push to upstream

Problems with basic operations

• After clicking Commit;• If you cannot Push to Upstream;• You can fix this problem in theway shown before.

Push. . .with more settings

Right click on the project that you want to push and Team→Remote→Push

Select Custom URI and paste in the URI tab the ssh link to your repository.

The ssh form is:

[email protected]:username/project.git

In my case

[email protected]:francescoS/JavaForHydrologists.example.git

Select the ssh protocol andEclipse will fill all tabsautomatically. After click Next

In the window Push to: origin click on drop-down menu of the Source ref andselect master [branch] or the branch you want

Click to Add Spec on the right and Next.

Click to Add Spec on the right and Next.In the other windows you can see a small summary of the push operation, thenclick Finish.

Push...with more settings

After Push operations, the appeared Dialog shows the Push Results.

Clone project

Introduction

If we are arrived here, I suppose you have your Git Repositories view in theEclipse IDE, otherwise return to 15.

Using the Git Clone Wizard you may clone remote repositories using differenttransport protocols. The wizard can be started by clicking on the botton Clonea Git Repository and add the clone to this view

Clone project

Repository Selection

Copy the URL from GitHub page of the searched project (in this casehttps://github.com/francescoS/JavaForHydrologists.firstClone) andpaste it in the URI space of the Clone Git Repository Dialog.

The other fields (Host and Repository path) are filled automatically by Eclipse.Riccardo Rigon, Francesco SerafinMarch 20, 2014 34 / 48

Clone project

Copy the URL from GitHub page of the searched project (in this casehttps://github.com/francescoS/JavaForHydrologists.firstClone) andpaste it in the URI space of the Clone Git Repository Dialog.

The other fields (Host and Repository path) are filled automatically by Eclipse.Riccardo Rigon, Francesco SerafinMarch 20, 2014 34 / 48

Clone project

You must fill the fields User and Password with your credentials of GitHub.

Clone project

You must fill the fields User and Password with your credentials of GitHub.

Clone project

Branch Selection

Click Next, in the Open Dialog choose wich branches shall be cloned from theremote repository (in this case there is only one branch).

If you are not sure which branches youneed, simply hit Select All. You canfilter the branches by their name bytyping using the text control above thelist.

Clone project

Local Destination

Click Next, in the Open Dialog select the Directory where store the repositoryon the local file system and define some initial settings. .

Clone project

Local Destination

Click Next, in the Open Dialog select the Directory where store the repositoryon the local file system and define some initial settings. .

Clone project

Local Destination

Click Next, in the Open Dialog select the Directory where store the repositoryon the local file system and define some initial settings. Click Finish.

Import the project in the Package Explorer

Now, to modify the project that you cloned before, you have to import it in yourPackage Explorer. Thus, right click on the view Package Explorer and Import.

Select Git→Project from Git

Select Git→Project from Git and click Next.

Select Existing local repository and click Next.

Select the repository JavaForHydrologists.firstClone and click Next.

Select Import existing projects and click Next.

This is the last Dialog, that summarizes the projects that you are importing.Then click Finish.

Now the project is visible in the Package Explorer and you can modify it.

How to view Git History

Git History

But first to modify a cloned repository, it’s important to examine the history ofthe entire project. So we are going to open a new tab in our Eclipse IDE:History.

• Click toWindow→Show View→Other ;

• Search and expand Team;• Then select History and click OK.

Git History

Now the History tab is open and you can examine all the history of the projecton which you are going to work.

Git History

Now the History tab is open and you can examine all the history of the projecton which you are going to work.

Introduction

Modify the JavaForHydrologists.firstClone project

Now you can modify the simple code that we just cloned.

Some tips:• you can use the TextIO class rather than simple System.out.println();• you can read the string from console, so you can create two simplemethods:

• Read from console;• Write in console.

• COMMENT ALL NEW LINES!

Introduction

A useful tip: JAutodoc

If you want to have a good standard to comment your code, you can useJAutodoc. It is an Eclipse Plugin for automatically adding Javadoc and fileheaders to your source code. It optionally generates initial comments fromelement name by using Velocity templates for Javadoc and file headers.

Introduction

A useful tip: JAutodoc

If you want to have a good standard to comment your code, you can useJAutodoc. It is an Eclipse Plugin for automatically adding Javadoc and fileheaders to your source code. It optionally generates initial comments fromelement name by using Velocity templates for Javadoc and file headers.

First install it:Help→Eclipse Marketplace and searchJAutodoc.

Introduction

How to use JAutodoc

To use JAutodoc, right click on the code and JAutodoc→Add javadoc.

using git inside eclipse, pushing/cloning from github

Education

local push

remote clone remote

local repository

cloned project git

given project

cloned project objectives

git revision control

francesco serafin