tycho-eclipserun:eclipse-run

Full name:

org.eclipse.tycho.extras:tycho-eclipserun-plugin:3.0.2:eclipse-run

Description:

Launch an eclipse process with arbitrary commandline arguments. The eclipse installation is defined by the dependencies to bundles specified.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.

Required Parameters

Name Type Since Description
<repositories> List - p2 repositories which will be used to resolve dependencies. Example:
<repositories>
 <repository>
  <id>juno</id>
  <layout>p2</layout>
  <url>https://download.eclipse.org/releases/juno</url>
 </repository>
</repositories>

Optional Parameters

Name Type Since Description
<addDefaultDependencies> boolean - Whether to add default dependencies to bundles org.eclipse.equinox.launcher, org.eclipse.osgi and org.eclipse.core.runtime.
Default value is: true.
<appArgLine> String - Arbitrary applications arguments to set on the command line. It is recommended to use applicationArgs instead because it provides more explicit control over argument separation and content, avoiding the need to quote arguments that contain spaces.
<applicationArgs> List 0.24.0 List of applications arguments set on the command line. Example: <applicationArgs> <arg>-buildfile</arg> <arg>build-test.xml</arg> </applicationArgs>
Alias is: applicationsArgs.
<argLine> String - Arbitrary JVM options to set on the command line. It is recommended to use jvmArgs instead because it provides more explicit control over argument separation and content, avoiding the need to quote arguments that contain spaces.
<bundleStartLevel> BundleStartLevel[] - Bundle start level and auto start configuration used by the eclipse runtime. Example:
<bundleStartLevel>
  <bundle>
    <id>foo.bar.myplugin</id>
    <level>6</level>
    <autoStart>true</autoStart>
  </bundle>
</bundleStartLevel>

<clearWorkspaceBeforeLaunch> boolean - Whether the workspace should be cleared before running eclipse.

If false and a workspace from a previous run exists, that workspace is reused.


Default value is: true.
<defaultStartLevel> BundleStartLevel - The default bundle start level and auto start configuration used by the runtime for bundles where the start level/auto start is not configured in bundleStartLevel. Example:
  <defaultStartLevel>
    <level>6</level>
    <autoStart>true</autoStart>
  </defaultStartLevel>

<dependencies> List - Dependencies which will be resolved transitively to make up the eclipse runtime. Example:
<dependencies>
 <dependency>
  <artifactId>org.eclipse.ant.core</artifactId>
  <type>eclipse-plugin</type>
 </dependency>
</dependencies>

<environmentVariables> Map - Additional environments to set for the forked JVM.
<executionEnvironment> String - Execution environment profile name used to resolve dependencies.
Default value is: JavaSE-17.
<forkedProcessTimeoutInSeconds> int - Kill the forked process after a certain number of seconds. If set to 0, wait forever for the process, never timing out.
User property is: eclipserun.timeout.
<jvmArgs> List 0.25.0 List of JVM arguments set on the command line. Example: <jvmArgs> <arg>-Xdebug<arg> <arg>-Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=1044</arg> </jvmArgs>
<project> MavenProject - (no description)
User property is: project.
<skip> boolean - Whether to skip mojo execution.
Default value is: false.
User property is: eclipserun.skip.
<work> File - Work area. This includes:
  • <work>/configuration: The configuration area (-configuration)
  • <work>/data: The data ('workspace') area (-data)

Default value is: ${project.build.directory}/eclipserun-work.

Parameter Details

<addDefaultDependencies>

Whether to add default dependencies to bundles org.eclipse.equinox.launcher, org.eclipse.osgi and org.eclipse.core.runtime.
  • Type: boolean
  • Required: No
  • Default: true

<appArgLine>

Arbitrary applications arguments to set on the command line. It is recommended to use applicationArgs instead because it provides more explicit control over argument separation and content, avoiding the need to quote arguments that contain spaces.
  • Type: java.lang.String
  • Required: No

<applicationArgs>

List of applications arguments set on the command line. Example: <applicationArgs> <arg>-buildfile</arg> <arg>build-test.xml</arg> </applicationArgs>
  • Type: java.util.List
  • Since: 0.24.0
  • Required: No
  • Alias: applicationsArgs

<argLine>

Arbitrary JVM options to set on the command line. It is recommended to use jvmArgs instead because it provides more explicit control over argument separation and content, avoiding the need to quote arguments that contain spaces.
  • Type: java.lang.String
  • Required: No

<bundleStartLevel>

Bundle start level and auto start configuration used by the eclipse runtime. Example:
<bundleStartLevel>
  <bundle>
    <id>foo.bar.myplugin</id>
    <level>6</level>
    <autoStart>true</autoStart>
  </bundle>
</bundleStartLevel>
  • Type: org.eclipse.sisu.equinox.launching.BundleStartLevel[]
  • Required: No

<clearWorkspaceBeforeLaunch>

Whether the workspace should be cleared before running eclipse.

If false and a workspace from a previous run exists, that workspace is reused.

  • Type: boolean
  • Required: No
  • Default: true

<defaultStartLevel>

The default bundle start level and auto start configuration used by the runtime for bundles where the start level/auto start is not configured in bundleStartLevel. Example:
  <defaultStartLevel>
    <level>6</level>
    <autoStart>true</autoStart>
  </defaultStartLevel>
  • Type: org.eclipse.sisu.equinox.launching.BundleStartLevel
  • Required: No

<dependencies>

Dependencies which will be resolved transitively to make up the eclipse runtime. Example:
<dependencies>
 <dependency>
  <artifactId>org.eclipse.ant.core</artifactId>
  <type>eclipse-plugin</type>
 </dependency>
</dependencies>
  • Type: java.util.List
  • Required: No

<environmentVariables>

Additional environments to set for the forked JVM.
  • Type: java.util.Map
  • Required: No

<executionEnvironment>

Execution environment profile name used to resolve dependencies.
  • Type: java.lang.String
  • Required: No
  • Default: JavaSE-17

<forkedProcessTimeoutInSeconds>

Kill the forked process after a certain number of seconds. If set to 0, wait forever for the process, never timing out.
  • Type: int
  • Required: No
  • User Property: eclipserun.timeout

<jvmArgs>

List of JVM arguments set on the command line. Example: <jvmArgs> <arg>-Xdebug<arg> <arg>-Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=1044</arg> </jvmArgs>
  • Type: java.util.List
  • Since: 0.25.0
  • Required: No

<project>

(no description)
  • Type: org.apache.maven.project.MavenProject
  • Required: No
  • User Property: project

<repositories>

p2 repositories which will be used to resolve dependencies. Example:
<repositories>
 <repository>
  <id>juno</id>
  <layout>p2</layout>
  <url>https://download.eclipse.org/releases/juno</url>
 </repository>
</repositories>
  • Type: java.util.List
  • Required: Yes

<skip>

Whether to skip mojo execution.
  • Type: boolean
  • Required: No
  • User Property: eclipserun.skip
  • Default: false

<work>

Work area. This includes:
  • <work>/configuration: The configuration area (-configuration)
  • <work>/data: The data ('workspace') area (-data)
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/eclipserun-work