Skip to content

Latest commit

 

History

History
79 lines (56 loc) · 3.65 KB

install.md

File metadata and controls

79 lines (56 loc) · 3.65 KB
Raw

Installing Eclipse and the Bazel Eclipse Feature

This page documents how to get up and running with Eclipse and the Bazel Eclipse feature. These instructions are for users that just want to use the Bazel Eclipse feature.

👷There is a different installation process if you want to actually make changes to the feature.

This section will eventually contain a matrix of supported configurations. But at this point, we are not that organized. Install a recent copy of whatever is asked for below, unless a specific version is noted.

Supported Platforms

We will support you on:

  • Mac - reasonably recent OS versions
  • Linux - reasonably recent OS version of a major distro (Ubuntu, Mint, etc)

Windows support is tracked as Issue 36, see that work item for current status. Other platforms may also work, but you may need to contribute patches if there are issues.

Installing a JDK

At this time, we don't have specific guidance on what JDK version you should be using. Any JDK 8 or above should work. We support old and new versions of Java, so whatever you pick should just work. If you find one that does NOT work, let us know. More details of our JDK support strategy can be found here.

Installing Eclipse

Download the latest release of Eclipse IDE for Java Developers. The feature is built against a recent version of the Eclipse SDK, so older versions won't work.

Launching Eclipse

This seems like it is a no-brainer. Eclipse has been around for two decades, so it should launch with no issues. But it doesn't launch in some cases, at least on Macs. Consult this doc if your Eclipse fails to launch on Mac.

Installing Bazel

The Bazel Eclipse Feature does not come with an embedded install of Bazel. You must have Bazel installed on your machine and in your shell path.

The BazelVersionChecker has a version check when setting the Bazel executable in the Eclipse preferences. Choose a version of Bazel that is at least as high as that check.

Installing the Bazel Eclipse feature into Eclipse

You will first need to obtain an update site archive (.zip file) of the Bazel Eclipse feature, which is covered on this page. Next, follow these steps to install it in your Eclipse IDE.

Install the Bazel Eclipse feature into Eclipse:

  • Start Eclipse.
  • In Eclipse, go to Help -> Install New Software
  • Click the Add button
  • Click the Archive button
  • Locate the file bazel-eclipse-feature.zip and click Open
  • Give the location a name, like Bazel-Eclipse updatesite
  • Check the box next to the Bazel Eclipse Feature item, then hit Next
  • Click Next/Agree/Finish until it completes.
  • Restart Eclipse

To verify that it is installed:

  • Start Eclipse
  • Eclipse > About > Installation Details > Click on the Plugins Tab > search for Bazel: the feature's plugins should be in the list
  • In the Project Explorer view, you should be able to right-click, choose Import, and see a Bazel menu item.

Updating your Bazel Eclipse feature

If you would like a newer build of the Bazel Eclipse feature, you will need to re-install it. Repeat the above steps using an archive with a newer version.

Using the Bazel Eclipse Feature

Now that your tool chain is ready, it is time to start using it. We cover how to use the Bazel Eclipse feature in our User's Guide.