Introduction to github using Egit

Introduction to Github with Egit

2014/YuMatsuzawa/

Github??

• Google it, now.

• Or, https://github.com/

Introduction to Github 2

Github??

Make your account, now.

Github??

Make your account, now.

Or, Login if already got one.

You will see…

…then you are ready.

LOLWATTZDIS?

• With Github, you can…– Find/Clone/Help someone else’s nice projects.– Sync your progress across multiple machines.– Roll back your project to previous state. – Publish/Share your project.

• “Git” is one of many Version Control Systems (VCS).• Github is one of public platforms (hubs) of Git.

LOLWATSDIS?

• Seems nice, but what is ‘cloning’? Cloning a project is basically copying it to

your machine/environment to extend it as you like.

You can clone any public projects including very famous one such as jQuery (/jQuery/jQuery)

• How to help someone? Clone their project, modify, and offer

your help as ‘pull request’ (covered later)

LOLWATSDIS?

• Thanks a bunch! But how? Covered later in detail; in a few words:

1. Uploading your progress to Github2. Downloading it to other machines3. (Conflict shall be checked/marked)

• Is it automatic? NO. Why? Covered later.

LOLWATSDIS?

• Why this is important? When you mess up with your project and

it stops working (happens often), you can come back to the point it had worked.

• To any states before? Any limit? No limitation. Github doesn’t have “max

space.” You’ll see why.

LOLWATSDIS?

• Could be useful… but can I keep it private? NO. This is why github is free AND space-

unlimited. Projects uploaded on github is considered public assets(or Open Source Software) thus forcibly published.

• Really? …Unless you pay at least $7/month.

Now you know Github is

• Platform of distributed development for Open Source Software using Git– Actually, not limited to software. Any contents can

be managed on github (images, .doc, .xls, etc.)– You must acknowledge contents on Github is

published, thus you shouldn’t upload restricted contents (such as data including private info.)

– Let’s delve into “How”

From Where?

• Basic Git is CUI thing

– You may learn/use Git this way, and actually, sometimes, for some kind of people, it’s even easier. But for now…

• Let’s do this from Eclipse GUI (for Java users)

Requirement

• Any working Eclipse (not too old one)• ssh-keygen– Included in recent versions of Eclipse– Other ways:

• On Mac/Linux this is innately installed• On Windows:

– If you have cygwin installed, you’re OK.– If you have PuTTY or TeraTerm installed, you’re OK.– Otherwise, install TeraTerm.

» PuTTY and TeraTerm are both terminal emulator. For OpenSSH keygen purpose, TeraTerm is simpler and easier.

• … is Eclipse plugin for Git.• Install it.

1. Launch Eclipse2. Help > Eclipse Marketplace3. Search “EGit”4. Install

Prepare SSH public key

• Stay in Eclipse• Open “ 設定” (Preferences )– “ 一般” (General)>” ネットワーク接続” (Network Connection)>”SSH2”– “ 鍵管理” (Key Management)– “RSA 鍵の生成” (Generate RSA Key)– “ 秘密鍵の保管” (Save Private Key)• Default name would be “id_rsa”• Path should be <user>/.ssh/

Prepare SSH public key• If you already got one, new key isn’t required– Found “<user>/.ssh/id_rsa.pub” ? => Done.

• On Mac/Linux or Cygwin:– Launch Terminal or Cygwin– Type “ssh-keygen”

• Save/Move your key under <user>/.ssh/

• On TeraTerm:– Cancel “ 新しい接続”– “ 設定” > “SSH 鍵生成”

• Save under <user>/.ssh/

• On PuTTY:– Find PuTTYGen in PuTTY install directory– “ 生成” (Generate)– (Move cursor around)– “ 変換” (Convert)

>“OpenSSH 形式”• This is for private key

– Save as appropriate name• Default: <user>/.ssh/id_rsa• No extension needed

– Copy this• PuTTYGen generate original format ssh key• OpenSSH format key required• This is for pubic key

– Open text editor– Paste– Save as appropriate name• Default: “id_rsa.pub”

Register public key

Paste the content of generated id_rsa.pub here

Appropriate title

Specify SSH private key for Eclipse

• Generated your key via Eclipse? => Done.• If not:– Your key is <user>/.ssh/id_rsa? => Done.– If not:• Open “ 設定”• “ 一般” >” ネットワーク接続” >”SSH2”• “ 秘密鍵の追加” (Add Private Key)• Specify your key name

– Make sure it’s stored under <user>/.ssh/

Authentication Method

• “ 認証方法” (Authentication Methods)• Uncheck “password”– Only key authentication

• Now everything ready!

Create Repository

• What’s “repository”?– Storage for Git objects– There must be remote repository on Github AND

local repository on your machine– Concept: Transactions are done between

repositories (specific locations)

Create Remote Repository

Appropriate title

Description

Cannot choose Private on unpaid account

Make README

Share your existing project

• Open your project• Right click• チーム” Team”• プロジェクトの共用　“ Share the project”• “Git”

Create Local Repository

• Where to reposit?– Recommended: Distinct, new path dedicated only for

that repository outside of Eclipse workspace• Not the same as the already existing project directory

(usually in Eclipse workspace)• Why? -> Several reasons. Primarily for future use when you

would want to place multiple projects in that repo.• Faster (Git only cares about files inside the repo)

– Easier to understand: Project directory• No need to move files (easier to initialize)• Sometimes slower (Git starts to check files in workspace)

• Where to reposit?– Recommended: Distinct, new path dedicated only for

that repository outside of Eclipse workspace• Not the same as the already existing project directory

(usually in Eclipse workspace)• Why? -> Several reasons. Primarily for future use when you

would want to place multiple projects in that repo.• Faster (Git only cares about files inside the repo)

– Easier to understand/start: Project directory• No need to move files (easier to initialize)• Sometimes slower (Git starts to check files in workspace)

…If you are certain about 1 project <-> 1 repo philosophy

Aforementioned recommendation

Ignore warning and create repo

• If you are to place your repo outside of Eclipse workspace…

Default path would be /<user>/git/After proceeding, project migration to new path will begin.

Repository Ready

Open Git repositories pane.ウィンドウ > ビューの表示 > その他 >チーム

Indicators appeared(‘>’,’?’,’[NO-HEAD]’,…)

A little backtracking

• It’s good time to learn how exactly Git works.

GithubYour Machine

Your Eclipse

• You’ve created repositories.

Github

Your Eclipse

Remote RepositoryLocal Repository

Your Machine

• Obviously, you want to store your project.

• …but making repository is just a first step.

Github

Your Eclipse

Your Machine

• Inside repos are indexes (file lists)

• Indexes track what files belong to the repos

Github

Your Eclipse

Your Machine

Index-…-…-…

• Inside repos are indexes (file lists)

• Indexes track what files belong to the repos

• You can ‘git add’ to the index

Github

Your Eclipse

Your Machine

Index-File1-File2-…

Index-…-…-…

‘git add’!!

Added!

• Now the local repo knows your files

• But only their existence.• Repo must know if files are

ready to be shared/launched

Github

Your Eclipse

Your Machine

Index-…-…-…

• Your next move is to register your progress

• •

Github

Your Eclipse

Your Machine

Index-…-…-…

• Your next move is to register your progress.

• ‘git commit’ is the way to go.• Records your current progress

on indexed files to the repo.

Github

Your Eclipse

Your Machine

Index-…-…-…

‘git commit’!!

• You commit to a specific “branch”

• Branch = Front-ends of devel. flows (latest commits)

First commit creates ‘master’

Github

Your Eclipse

Your Machine

Index-…-…-…

masterCreated!

• If you modify your files and commit again,

Github

Your Eclipse

Your Machine

Index-…-…-…

‘git commit’!!

master

• If you modify your files and commit again,

• …that records are committed to currently targeted branch (in this case ‘master’). New one becomes branch.

Github

Your Eclipse

Your Machine

Index-…-…-…

master

c00 c01

• You can make another branch

Github

Your Eclipse

Your Machine

Index-…-…-…

master

c00 c01 c02 c03

another

• Committing to another branch will separate the flow.

Github

Your Eclipse

Your Machine

Index-…-…-…

master

c00 c01 c02 c03

a01a00

another

• Committing to another branch will separate the flow.

• Also you can merge them.

Github

Your Eclipse

Your Machine

Index-…-…-…

master

c00 c01 c02 c03

a01a00

• If branches conflict (like edited same file),

Github

Your Eclipse

Your Machine

Index-…-…-…

master

c00 c01 c02 c03

a01a00

another

• …Git notifies conflicting files.

Github

Your Eclipse

Your Machine

Index-…-…-…

master

c00 c01 c02 c03

a01a00

another

• …Git notifies conflicting files.• Then you must manually fix

conflicts then add again.

Github

Your Eclipse

Your Machine

Index-…-…-…

master

c00 c01 c02 c03

a01a00

another

Fix & ‘git add’!!

• …Git notifies conflicting files.• Then you must manually fix

conflicts then add again.

Github

Your Eclipse

Your Machine

Index-…-…-…

master

c00 c01 c02 c03

a01a00

• Anyway, let’s go committing for now!

• Back to Eclipse…

Github

Your Eclipse

Your Machine

Index-…-…-…

masterCreated!

Add/Commit

These indicator means:> -Uncommitted changes exists? -Not added to the index* -Added but uncommitted (‘staged’)[<branch name>] -Current branch**

**Pointer/cursor to current branch is called ‘HEAD’. ‘NO-HEAD’ means no branch specified.

Add/Commit

• Right click on the project,• “ チーム” (Team),

• You’ll find its contents changed• “ コミット” (Commit)

• (You can do the same thing by right-clicking the repository from the repositories pane.)

Add/Commit

• (This window can differ from an Eclipse version to another, this is Juno 4.2.2)

• Commit Message is important feature used for explaining what changes are made.• Keep it simple but understandable

• If there are untracked files, you can add them here. (Check this “Show untracked”)

Hit “Commit” if messages/adding files are ready

Add/Commit

• Gratz! Your first LOCAL commit (+ add) is made.

• You notice the ‘>’ indicator disappeared from the project.– This means the local repository

now stored your progress.

“Remote Control”

• Next step is to interact with the remote repo.

Github

Your Eclipse

Your Machine

Index-…-…-…

masterCreated!

• Next step is to interact with the remote repo.

• Remote contents are managed with similar branch system.

• On repo creation, remote ‘master’ was also made.

Github

Your Eclipse

Your Machine

Index-…-…-…

master

• Now, you need special local branch.

Github

Your Eclipse

Your Machine

Index-…-…-… r00

masterc00

master

• Now, you need special local branch.

• So-called “remote tracking”• This branch tracks/syncs with

status of remote branch.

Github

Your Eclipse

Your Machine

master

origin/master

master

• ‘origin’ means it’s your primary remote repo.

• ‘origin/master’ means it syncs with ‘master’ branch on your remote repo.

Github

Your Eclipse

Your Machine

master

origin/master

*These are just a common tactics to name a remote tracker. You may name yours as you want.

master

• Tracker will ‘git fetch’ the remote contents.

• The first fetch creates the remote tracker.

Github

Your Eclipse

Your Machine

master

origin/master Created!‘git fetch’!!

master

• Then you merge 2 local branches.

Github

Your Eclipse

Your Machine

Index-…-…-…

master

origin/master

• Then you merge 2 local branches.

• Now local ‘master’ contains all contents from local & remote.

Github

Your Eclipse

Your Machine

Index-…-…-…

master

origin/master

*In distributed developments, conflicts can happen on this phase.**If you followed this instruction, local ‘master’ contains your local project and initially created README from remote at this moment.

• With fetch & merge, local branch is up-to-date

• Normally you do this before starting your work of the day.

• You may just ‘git pull’ here.

Github

Your Eclipse

Your Machine

Index-…-…-…

master

origin/master

*Pull basically means ‘fetch then merge’ combined.

• Next move obviously, is going opposite way

Github

Your Eclipse

Your Machine

Index-…-…-…

master

origin/master

• Next move obviously, is going opposite way

• At this point all tools are set.• ‘git push’ will do the trick.

Github

Your Eclipse

Your Machine

Index-…-…-…

master

origin/master

*Push will commit to the remote tracker, then sync it to the branch on the remote by uploading/overwriting contents.**Again, conflicts can happen here, and your push sometimes ‘rejected’ by the remote. If so, you need to fetch & merge.

‘git push’!!

• So, in summary:

• Pull (fetch & merge). Remote tracker created. (Do work.) Push. Done. Let’s do this ->

Github

Your Eclipse

Your Machine

Index-…-…-…

master

origin/master

r01r01

Remote Configuration

Back to Web Browsers.Your Remote Repo page.

Copy this address.Make sure its ‘SSH’.

*You registered SSH key, so you can pull/push via SSH connection.**You can pull via HTTPS, but cannot push.

In the Repo Pane, under the repo> “ リモート” (Remote)

Right click> “ リモートの作成” (Create a remote)

In the Repo Pane, under the repo> “ リモート” (Remote)

• Making push configuration first would be a little easier.

Push Configuration

Click this to expand

Push Configuration

PushConfiguration

Your copied address should automatically be inserted from clipboard.

No need to modify username/password.‘git’ is global username, auth’ed by key

Push Configuration

What was HEAD? > Reference to current branch.

Click & focus here, then hit Ctrl+Space

Push Configuration

Complement service will automatically search existing remote branches.Choose ‘master’ branch.

Push Configuration

Checking this has literal meaning.When pushing, it will ignore push rejection from the remote branch and forcibly push the local HEAD.Generally a bad idea.

Push Configuration

• Repositories Pane should now be like this.

Push Configuration

• Repositories Pane should now be like this.• Right click on ‘origin’• “ フェッチの構成” (Configure fetch)

Fetch Configuration

Exactly the same as push

Fetch Configuration

Again, click & focus here, then hit Ctrl+Space.Choose ‘master’.

Fetch Configuration

Another overwrite option.Better not check.

Fetch Configuration

Now that fetch configuration is ready, let’s try fetching for the first time!Remember, first fetch will create the remote tracking branch ‘origin/master’

Result should be like this.

Server certification acceptance may be prompted.

Remote Tracking Branch

• Under “ ブランチ” (Branch)>” リモート・トラッキング” (Remote tracking), you will find ‘origin/master’

• To reflect the remote status to local…

• Right click on the remote tracker• “ マージ” (Merge)

• At this time, result should be like this.• Key is ‘Fast-forward’(FF)– Basically means no conflicts there.– To be precise, one branch is wholly older, and its

recent commit is included in the other.

• Here comes README from the remote joining the local.

• Finally, to upload this merged commit to the remote…

2 ways of doing this:

Right click on the project> “ チーム” (Team)>” アップストリームへプッシュ” (Push to upstream)

orRight click on ‘origin’ under “ リモート”>” プッシュ” (Push)

• Result should be like this.• At this time no rejection for sure.

Check on Github

Back to Web Browsers.Try refresh.

Check on Github

Happy face

Easier way for daily use

• Now the very basic git usage is covered.• May pull / commit and push as shortcut.

Versioning

• Versioning is done through tagging in git.• You may noticed “ タグ” (Tag) in the repo

pane.• Right click and “ タグの作成” (Create a tag)

Hit this to expand

Appropriate name (such as v1.0, v2.4-beta)

Description message

Choose a commit you want to tag

• Now that commits are tagged.• If you want to publish these tags (versions),

you need to push tags manually.– Not tied to branch pushing, but the concept is

exactly the same.

Push Tag

• Right click on the tag > “Push Tag”• “ 構成済みレポジトリー”

(Configured Repository)• Hit Next

Push Tag

• Tricky part: Tags are referred like ‘refs/tags/<tag name>’.

Push Tag

• You need to manually specify this.

Target name

Push Tag

• You need to manually specify this.

• Basically just copy the name above.

Target name (refs/tags/v1.1)

Push Tag

• Result should be like the left• On Github, ‘releases’ should appear and you

can see the version history

Versioning

• Versioning itself needs its own philosophy and practice, and it’s ultimately depends on how the team will handle the project.

• Make/follow the guideline and decide when/how often/what kind of state to publish.

From Remote, Comes…

• So far, we assumed you have your local project developed without using git.

• And how to integrate it with git is covered.

• Let’s see how to duplicate your git-integrated project to your extra machines.

• Or to duplicate other’s project.– These are done with exact same procedure.

• You can ‘git clone’ the remote repo itself.

Github

Your Eclipse

Remote Repository

Your MachineIndex-…-…-… r00

master

• You can ‘git clone’ the remote repo itself.

• And it’s really easy!• Not only it copies contents of

the repo, it automatically set all the remote configuration!

Github

Your Eclipse

Remote Repository

Your MachineIndex-…-…-… r00

master

Local Repository

master

origin/master

‘git clone’!!Created!

Created!

• All you need is…

• Copy.

• On your target machine,• Right click on the blank area of the repo pane.• “ リポジトリー・パスまたは URI の貼り付け”

Same as before.

You cannot clone to non-empty path.

If the repo includes Java project, you can also import them.

• With cloning, you can duplicate your Eclipse project env. on another machine with ease.– As long as you respect the procedure of

pull/modify/commit/push, you can work on your project from various places without an issue.

– But sometimes an error will happen. And in a team development conflicts are common.• To prevent your working branch being overwritten by a

problematic commit, there is no auto-pull.• To prevent not-ready code being sent to the remote, there is

no auto-commit/push.

Clone/Fork

• You can clone other developer’s repository, and modify on branches as you like.– You may do this on Github alone, creating the remote

clone of the original in your account. (Called forking.)– Note: However, pushing to original repository is only

allowed to the repo’s owners.• If you have done valuable modification to the branch of

cloned/forked repo, you can ‘pull request’ to the owner.• Push your branch to forked repo, then submit pull request

on the original repo.

.gitignore

• Sometimes you want certain files to stay untracked/excluded from index.– Especially data including privacy info.

• Then you can “ 無視” (ignore) such data.– Listed on .gitignore

• After that, commit thebranch– .gitignore will be added

Back to the Past

• So how to return to previous state?• 1-step back (just want to discard 1 commit):– Already pushed? > git revert. Making new commit.

• But your code may already be used by someone.– Not pushed? > Amend commit, or reset and start over.

• Multi-step back– Make new branch on the past commit, checkout (means

moving your current branch(HEAD)), work on it, eventually merge with master, or discard old master and name the current as new master.

– Branching is has high flexibility.

Other stuff

• There are many more functions in git– Notably rebase.

• But for now, that’s it!– For personal/laboratory use, we learned more

than enough I believe.

• Utilize my account(/YuMatsuzawa/) for testing

CUI (Git for Windows required)

• $ cd <project directory>• $ git init #repo created• $ git add <files to be added>• $ git commit –a #commit all• $ git remote add origin <remote URI>

#remote config• $ git fetch origin #fetch any branches• $ git merge origin/master #merge remote tracker• $ git push origin master #push to remote

Introduction to github using Egit

elses nice

version control

open source

place multiple

existing project

c00 master

special local

manually fix

Software

Using github development process in your company

Egit Tutorial

Using Github for DSpace development

EGit 1.0 and Beyond

Using GitHub in Large Software Engineering Classes: An ...

EGit wird erwachsen Git, Github und Gerrit – alles in der....

An Introduction to GIS Using QGIS (v. 2.12.2) - GitHub

Egit democamp-darmstadt-2011-06-21

Git & GitHub 소개 - KOCWcontents.kocw.net › document ›...

Using The EGit Eclipse Plugin With Git Hub

RGB Digital Image Forgery Detection Using ... - GitHub Pages

How we built our community using Github - Uri Cohen

EGIT | Enterprise Governance of...

O'Leary - Using GitHub for Enterprise and Open Source...

EGit in Eclipse - Bandlem · 2010. 6. 21. · Eclipse...

Using Git and GitHub Effectively at Emerge Interactive