-
Notifications
You must be signed in to change notification settings - Fork 597
Development Tools
- Overview Open Liberty Development
- Next step: Step B: Setting up the Open Liberty git repository
- Step 1 : Install Git runtime (and optionally a Git UI Client)
- Step 2 : Install Java 8
- Step 3 : Optional - Install Eclipse with and Bnd Tools
- Step 4 : Optional - SSH exchange instructions for GitHub
- Step 5 : Optional - Setup eGit SSH inside of Eclipse
- Step 6 : Optional - Install ZenHub
-
Download and install Git. Execute the file you downloaded, and accept the defaults.
-
Download and install Git Large File Storage (LFS).
-
Optionally, you can install a Git UI Client, but this step is 100% optional, and not needed if you plan on using Eclipse. Here is a list of Git UI Clients.
-
Windows users performance tip: Always start any git client including the git bash shell with "Run as Administrator"
-
Configure your user name and email address.
$ git config --global user.name "John Doe"$ git config --global user.email [email protected] -
If you don't want to use "vi" editor when writing up the description for your commits, point git to your favorite text editor:
$ git config --global core.editor 'c:/utility/emacs-24.3/bin/emacs.exe'
Java 8 is the minimum version required to build Open Liberty. Popular choices are: * The IBM SDK * OpenJDK * Oracle JDK
For Windows, you can also download an Eclipse bundle which includes the IBM SDK: * IBM Development Package for Eclipse
Once installed, ensure that the JDK is on your PATH.
To start developing Open Liberty it is recommended that contributors download the Eclipse IDE for Java Developers and the Bnd Tools plugin for eclipse. It is recommended to download Eclipse 4.6 (Neon) or higher which also includes the eGIT plugin. Detailed installation instructions along with Java JRE/JDK requirements can be found at this link Eclipse/Installation:
- Download and install Eclipse Neon
- Install Bnd Tools for your eclipse workspace
- Configure Eclipse to use the JVM.
- Windows users performance tip: Same as above, always start the eclipse client with "Run as Administrator"
Eclipse workspace directory: Eclipse will prompt you to select a workspace directory at some point (typically before starting for the first time). Your Eclipse workspace can theoretically be created just about anywhere, however it is recommended that the Eclipse workspace directory is kept separate from your local git repository.
Install ZenHub. ZenHub allows for viewing GitHub Issues on a task (aka kanban) board, and creation of Epic Issues.
For an existing key do the following:
- Check for Existing SSH keys.
- Add your existing SSH key to your GitHub account via these instructions.
For a new SSH key do the following:
- Complete the steps under Generate a new SSH key to generate your key.
- Complete the steps under Adding your SSH key to the ssh-agent to add your key.
NOTE: All git commands which touch the network (fetch, push, pull) use SSH authentication. Ensure that you've started your SSH agent:
- Inside of Eclipse navigate to Window -> Preferences -> General -> Network Connections -> SSH2.
- On the General tab, ensure that the "SSH2 home" setting is pointing to the location where your key is stored.
- On the Key Management tab, click the "Load Existing Key" button and select the id_rsa file (or other file if you've named your key differently than the default).
- Enter your passphrase when prompted.
- Optionally, you can enter your passphrase on the Key Management tab to reduce prompts for entering it manually.
- Click OK to complete the configuration.