EGit/Gerrit Hands-on training #1: Installation and Configuration

Size: px

Start display at page:

Download "EGit/Gerrit Hands-on training #1: Installation and Configuration"

Millicent Dorsey
6 years ago
Views:

1 EGit/Gerrit Hands-on training #1: Installation and Configuration Introduction To use git from Eclipse you need the EGit plug-in. With EGit you do nearly all of your gitrelated tasks. But for certain operations you may want to use the command-line git. This exercise is about installing EGit. Installation of command-line git is explained in a later exercise (exercise #8) when it is needed. In the tutorial session at EclipseCon the necessary software is distributed via a memory stick. The paths in the description below are relative to the path of the location where you copied the stick content to. If possible try to do the steps described in this first exercise already before the tutorial at EclipseCon, then you may skip the boring installation part during the EclipseCon session and you will have some more time for the more advanced exercises there. Eclipse Packages To save time you may want to just use the eclipse-sdk package matching your platform, if you want to use an existing Eclipse installation and install EGit into it look at the next section instead : Unzip the eclipse-sdk package matching your platform <stick>/software/<platform>/eclipse-sdk <os>-<ws>-<arch>.zip they already have an EGit nightly version pre-installed in the dropins folder. Installation To install EGit into an existing Eclipse installation (anything from 3.5 to 3.7 should work) follow this section. For the sample project you will need an Eclipse installation having JDT and PDE. Install latest EGit (Version or nightly) Start Eclipse and navigate to Help > Install new software > Add... As software site enter the path to the update site on the memory stick: latest EGit release (0.11.3): <stick>/software/egit-0.11 or EGit nightly build: <stick>/software/egit-nightly if you install EGit prior to the tutorial you may also use the standard download sites

latest EGit release (0.11.3): Main P2 Repository: http://download.eclipse.

2 latest EGit release (0.11.3): Main P2 Repository: (Recommended) Via the Eclipse Marketplace or EGit nightly build: Select Eclipse EGit (Incubation) and Eclipse JGit (Incubation) and click Next to finish the installation. During the installation you will be asked to accept the License Agreements. Registration and Configuration 1. Create an account for our Gerrit server at Eclipse Register a user account Use Register New to register your address with our Gerrit Code Review server. This step is required to validate that the address is correct. Confirm that you agree to the Eclipse.org Terms of Service by completing the Individual Contributor agreement. You ll receive an containing a confirmation link, confirm this to activate your account. URLs for Gerrit at egit.eclipse.org: HTTP protocol: SSH protocol: ssh://<username>@egit.eclipse.org:29418/egittraining.git

Gerrit WebUI : http://egit.eclipse.org/ GitWeb : http://egit.eclipse.org/w/?p=egit-training.git;a=summary If the network is down or you are offline you may run a preconfigured demo Gerrit locally.

3 Gerrit WebUI : GitWeb : If the network is down or you are offline you may run a preconfigured demo Gerrit locally. In that case first go through exercise 9-Starting-Demo-Gerrit and then come back to this exercise. If you do the exercises using the local demo Gerrit the URLs for git communication with Gerrit are different: HTTP protocol (note the extra /p): SSH protocol: ssh://developer01@localhost:29418/egit-training.git Gerrit WebUI is then reachable under : there is no GitWeb included in the demo Gerrit installation 2. EGit configuration Windows only: HOME environment variable (if not set EGit will ask when you use EGit for the first time). Please check if it is set to your user directory. Hint: Git needs to know who (user & ) commits to a repository. Don t worry: when EGit needs this information for the first time it will ask you. Communication Protocols Git supports many communication protocols, for this tutorial either choose HTTP (section 3. below) or SSH (section 4. below) these choices provide both read and write access using the same URL to the central example repository hosted on Gerrit running on egit.eclipse.org. 3. HTTP configuration open and click Generate Password to generate your HTTP password

you may then communicate over HTTP using the URL http://egit.eclipse.

4 you may then communicate over HTTP using the URL egit-training.git and the credentials given on #settings,http-password 4. SSH configuration In Eclipse check the SSH configuration in Preferences > General > Network > Connections > SSH2

5 Check that your SSH2 home is set to <your home directory>/.ssh (on Windows: make sure it is.ssh and not ssh or _ssh) Check that Private keys is set to id_dsa,id_rsa If you don t have SSH keys yet In tab Key Management click Generate RSA key, type in a passphrase to protect your private key and click Save Private Key... Else, if you already have SSH keys, press Load Existing Key and select your private key (default is id_rsa ) While still in the SSH2 Key Management window copy the public key to the clipboard

Result Paste the public key into your Gerrit account settings at http:// egit.eclipse.org/r/#settings,ssh-keys and click Add It is crucial to check that your HTTP or SSH configuration is correct.

6 Result Paste the public key into your Gerrit account settings at egit.eclipse.org/r/#settings,ssh-keys and click Add It is crucial to check that your HTTP or SSH configuration is correct. To ensure that try to clone the example repository. You will need this repository to continue with the following exercises. Clone the example repository In Eclipse choose File > Import > Projects from git. Click Next and Clone. In the upcoming dialog enter if you use protocol: in the URI field and add Username and HTTP password given at if you use ssh:// protocol: ssh://<your in the URI field (find your Username at Do not enter anything into the password field, an extra dialog comes up if the

SSH passphrase is required Click Next. You should see some branch names in the next dialog. If instead an error pops up something is wrong with your configuration. Ask for help! Click Next. In the Directory field, choose a path where to store the local repository.

7 SSH passphrase is required Click Next. You should see some branch names in the next dialog. If instead an error pops up something is wrong with your configuration. Ask for help! Click Next. In the Directory field, choose a path where to store the local repository. The default path can be configured in Preferences > Team > Git in the field Default Repository folder Click Finish. Click Next and leave the defaults. Click Next and select the example project in the list. Click Finish to import the project into the Eclipse workspace. Example Project The example repository contains two projects org.eclipse.example.calc : contains a simple calculator with both a Swing UI and a SWT UI to launch the UI run the respective launch configuration, there is a separate launcher for the SWT UI on Mac. org.eclipse.example.calc.test : contains unit tests, to run them use the corresponding launch configuration

You may browse the central example repository using gitweb at: http://egit.eclipse.org/w/?p=egit-training.git;a=summary Find changes for egit-training.git waiting for code review here http://egit.

8 You may browse the central example repository using gitweb at: Find changes for egit-training.git waiting for code review here Configure Push URI git:// is a very efficient but non-authenticating protocol, hence it s typically used for reading operations only. In order to upload new changes using the Push command both the or ssh:// protocol can be used. In order to be able to push changes to Gerrit for code review with a single click you have to configure a Push URI: In the Package Explorer click on the project and choose Team > Remote > Configure Push to Upstream Click Add Enter refs/for/master into the Remote Branch field and click Ok Click Save EGit Documentation

in the workbench toolbar area and click Customize perspective.

9 The EGit user guide is bundled with the EGit feature, invoke it via Help > Help Contents > EGit Documentation. Git Workbench Toolbar and Menu In order to simplify usage of the most frequently used Git actions the Git Command Group can be activated to show a Git Workbench Toolbar and/or Menu right-click in the workbench toolbar area and click Customize perspective... in the tab Command Groups Availability click Git, this will enable both the Git workbench toolbar and menu in the tabs Toolbar Visibility and Menu Visibility you may configure which actions should appear in the Git Workbench toolbar and menu Repositories View To get an overview on your git repositories open the Git Repositories View. Select the example project and click Show in > Git Repositories.

Under Remotes > origin you see the fetch and the just created push configuration. To see the details select the URL and click Open Properties View.

10 Under Remotes > origin you see the fetch and the just created push configuration. To see the details select the URL and click Open Properties View. To see the complete repository configuration, click the same menu entry on the repository node. History View To browse the history of the repository, open the History View: On the repository node in the Git Repositories View click Show in History. Best you arrange the Repositories View and the History View next to each other, as shown below. Explore the diverse toggle buttons controlling the behavior of the history view. Especially try Show all branches and the filter buttons.