-
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 : SSH exchange instructions for GitHub
- Step 3 : Install Java 11
- Step 4 : (Optional) Install Eclipse with Bnd Tools
- Step 5 : (Optional) Install ZenHub
- Step 6 : (Optional) Setup eGit SSH inside of Eclipse
-
Download and install Git. Execute the file you downloaded, and accept the defaults.
-
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'
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:
eval "$(ssh-agent -s)"
Java 11 is the recommended version to build Open Liberty. Popular choices are:
Once installed, ensure that Java 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. A recent Eclipse version is required for Java 11 support.
-
Download and install Eclipse
- The eclipse installer offers you a choice of Eclipse versions
- For developing OpenLiberty, you can use the latest released version of Eclipse IDE for Java Developers
- If you don't use the installer, you may need to Configure Eclipse to use the JVM.
- Install Bndtools into your eclipse (either go to Help -> Marketplace and search or drag and drop from the marketplace page)
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.
- 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.