Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: for the plan.

Jump to: navigation, search

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 Papyrus project developer resources page.

Retrieve Papyrus code

To retrieve the papyrus code:

You can find a list of all available papyrus repositories here :

Configure access

Via EGit

First, you will have to clone the Git repository.

Git Clone1.png

Select the clone by URI.

Git Clone2.png

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.

Git Clone3.png

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

Git Clone4.png

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

Git Clone5.png

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

Add Git Repository1.png

Add Git Repository2.png

Add Git Repository3.png

To allow the user to commit anything Git will have to know your id and email. As such you can enter those variables in Preferences>Team>Git>Configuration and add the two entries:

  • key: / value: [your name]
  • key: / value: [your email]

EGit User Settings.png

If you do not have an ssh key yet, you can generate one using PuTTYgen ( ). Select Key>SSH-2 RSA 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.

Putty SSH1.png

Putty SSH2.png

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: (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.

Via command line

To clone the repository:

  • git clone [URI to clone the Git] [Folder in which you want to clone the repository]

For the configuration:

  • git config --global "[your name]"
  • git config --global "[your email]"

If you want to check your info:

  • git config --list

For the ssh key, just type the following command:

  • ssh-keygen -t [your key's type] -b [number of bits in length]

Command SSH.png

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 ssh-keygen -y -f [private key name], 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 Preferences>General>Network Connection>SSH2 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:

EGit ssh.png

Back to the top