View source for Papyrus/Papyrus Developer Guide/Papyrus Git Tutorial

The following tutorial will focus on the main repository but every repository in the papyrus constellation can be found in the [https://projects.eclipse.org/projects/modeling.mdt.papyrus/developer Papyrus project developer resources] page.


=== Retrieve Papyrus code ===

To retrieve the papyrus code: 
* via https : https://git.eclipse.org/r/papyrus/org.eclipse.papyrus.git
* via ssh : ssh://user_id@git.eclipse.org:29418/papyrus/org.eclipse.papyrus.git

<br/>You can find a list of all available papyrus repositories here :
* https://git.eclipse.org/c/papyrus/

=== Configure access ===


==== Via EGit ====

First, you will have to clone the Git repository.

[[File:git_Clone1.png|600px]]

Select the clone by URI.

[[File:git_Clone2.png|600px]]

As you can see, you have access to a number of ways to import the Git repository. Select the way you prefer and enter the corresponding address.

[[File:git_Clone3.png|600px]]

You then have to select the branches you want to import.

[[File:git_Clone4.png|600px]]

Then, at the moment of the creation, you will be asked which branch you want to be created by default.

[[File:git_Clone5.png|600px]]

<br /><br />

Once you already have a cloned Git repository, you have to add it to your "Git repository" view.

[[File:add_Git_Repository1.png|600px]]

[[File:add_Git_Repository2.png|600px]]

[[File:add_Git_Repository3.png|600px]]

<br /><br />

To allow the user to commit anything Git will have to know your id and email. As such you can enter those variables in <b>Preferences>Team>Git>Configuration</b> and add the two entries:
* key: <b>user.name</b> / value: <b>[your name]</b>
* key: <b>user.email</b> / value: <b>[your email]</b>

[[File:EGit_User_Settings.png|800px]]

<br /><br />

If you do not have an ssh key yet, you can generate one using PuTTYgen ( http://the.earth.li/~sgtatham/putty/latest/x86/puttygen.exe ). Select <b>Key>SSH-2 RSA</b> key in 2048 bits in length and just click generate. It is important to know that the key is generated by the random movements of the mouse inside the window, so don't wait for it to generate itself. then, save both keys in your .ssh folder.

[[File:putty_SSH1.png|600px]]

[[File:putty_SSH2.png|600px]]

<br />

Save your private key and your public key with the corresponding buttons. It is preferable to protect your key by adding a pass-phrase to it that will be asked every time you use it as a precaution. You should get two keys by the time this is finished: xxxx.pub (for your public key) and xxxx (for your private one). PuTTy may name your keys with its owned extensions but ignore it and rename them accordingly.

<br />

==== Via command line ====

To clone the repository:
* <b>git clone [URI to clone the Git] [Folder in which you want to clone the repository]</b>

For the configuration:
* <b>git config --global user.name "[your name]"</b>
* <b>git config --global user.email "[your email]"</b>
If you want to check your info:
* <b>git config --list</b>

For the ssh key, just type the following command: 
* <b>ssh-keygen -t [your key's type] -b [number of bits in length]</b>

[[File:command_SSH.png|1000px]]

<br /><br />

The steps are essentially the same as with PuTTY: generate the key, say where to save it and enter a pass-phrase. You can then test your new pair by entering <b>ssh-keygen -y -f [private key name]</b>, you will be prompt for the pass-phrase (if any) and your public key will pop up.

==== Adding the ssh key ====

Furthermore your will have to add the ssh key (if you want to commit via ssh) to <b>Preferences>General>Network Connection>SSH2</b> by setting the path to your .ssh folder and adding the name of your key to the private keys list.

As an example here is what this should look like when viewed inside your eclipse's Preferences page:

[[File:EGit_ssh.png|800px]]