Skip to content

Latest commit

 

History

History
104 lines (80 loc) · 4.69 KB

README.md

File metadata and controls

104 lines (80 loc) · 4.69 KB
Raw

The EPP Build with GNU MCU Eclipse plug-ins

The GNU MCU Eclipse EPP project

The GNU MCU Eclipse EPP project is a fork of the original Eclipse EPP project that adds the GNU MCU Eclipse plug-ins and intentionally does not go into further customisations, so that installing these binary packages is equivalent to installing the original Eclipse distribution followed by adding new software from the GNU MCU Eclipse update site.

The GNU MCU Eclipse binaries are available from the GitHub Releases; the release schedule generally follows the Eclipse release schedule.

The original Eclipse EPP project

The Eclipse Packaging Project (EPP) provides the download packages based on the content of the yearly Simultaneous Release. The download packages are provided from www.eclipse.org/downloads/eclipse-packages/.

Build a Package Locally

It's easy to run the build locally! All you need is Maven and then you need to tell Maven which package(s) to build via profile. As an example, the following command from the root of the Git repository builds the CPP, RCP/RAP package against the Simultaneous Release staging p2 repository:

mvn clean verify -Pepp.package.ccp
mvn clean verify -Pepp.package.rcp

This build creates output in two places:

  1. tar.gz/zip/dmg archives with the packages in archive/ and
  2. a p2 repository with the EPP artifacts in archive/repository/.

Windows users

If you are running the build on Windows, the last build step will currently fail. This failure can be circumvented by skipping the last step which aggregates the filtered EPP artifacts from the packages into a new p2 repository. For further details see bug 426416. At the moment it is advised to run the build command on Windows with package only:

mvn clean package -Pepp.package.ccp
mvn clean package -Pepp.package.rcp

In addition to that it is not possible to create zip and tar.gz archives on Windows due to missing Bash scripting capabilities. On Windows, the output of the build is the eclipse directory that contains the usual content from the zip archive. This directory can be found below (e.g. RCP package) packages/org.eclipse.epp.package.rcp.product/target/products/.

Available Profiles

Each package uses its own profile:

  • epp.package.committers
  • epp.package.cpp
  • epp.package.dsl
  • epp.package.java
  • epp.package.javascript
  • epp.package.jee
  • epp.package.modeling
  • epp.package.parallel
  • epp.package.php
  • epp.package.rcp
  • epp.package.reporting
  • epp.package.rust
  • epp.package.scout
  • epp.package.testing

With the signing profiles enabled, the build artifacts (bundles, features) and the Windows and macOS executables are signed. This is done by using the Eclipse Foundation internal signing service and can be activated only if the build is running there.

  • eclipse-sign-jar profile enables signing of the EPP bundles and jar files
  • eclipse-sign-mac profile enables usage of macOS signing service
  • eclipse-sign-dmg profile enables signing of the DMG files for the macOS platform
  • eclipse-sign-windows profile enables usage of Windows signing service

Additional Configuration Possibilities

By default, the EPP build uses the content of the Eclipse Simultaneous Release Staging repository at http://download.eclipse.org/staging/2018-12/ as input. Sometimes it is desired to build against another release (e.g. a different milestone), or against a local mirror of this repository. This can be achieved by setting the Java property eclipse.simultaneous.release.repositoryto another URL. As an example, by adding the following argument to the Maven command line, the EPP build will read its input from the composite Eclipse 2018-12 repository:

-Declipse.simultaneous.release.repository="http://download.eclipse.org/releases/2018-12"

Changes from Eclipse version

  • a gnumcueclipse branch was added
  • the URL of the GNU MCU Eclipse update site was added to the list of repositories
  • epp.product: the list of GNU MCU Eclipse features was added to the list of included features
  • the baseUri bug affecting builds on machines with spaces in folder names was fixed
  • the name of the generated archive was changed to include gnumcueclipse
  • the top README.md (this file) was slightly edited