Jump to: navigation, search

Difference between revisions of "Tycho/Release Notes/0.16"

(grouped new&noteworty by topic (like on the 0.17 page))
(document why new composite artifact behaviour is good (and not primarily how to disable it); some polishing)
Line 11: Line 11:
 
=== Compiler ===
 
=== Compiler ===
  
* <tt>tycho-compiler-plugin</tt> now has a boolean option <tt>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=384113 requireJREPackageImports]</tt> which will fail the build if set to <tt>true</tt> and non-java.* packages provided by the JDK are not explicitly imported. <br/> This is the design-time equivalent of setting equinox runtime option <tt>[[Equinox Boot Delegation|osgi.compatibility.bootdelegation=false]]</tt>.
+
* <tt>tycho-compiler-plugin</tt> now has a boolean option <tt>[http://www.eclipse.org/tycho/sitedocs/tycho-compiler-plugin/compile-mojo.html#requireJREPackageImports requireJREPackageImports]</tt> which will fail the build if set to <tt>true</tt> and non-java.* packages provided by the JDK are not explicitly imported. <br/> This is the design-time equivalent of setting equinox runtime option <tt>[[Equinox Boot Delegation|osgi.compatibility.bootdelegation=false]]</tt>.
  
 
=== Target Platform & Dependency Resolution ===
 
=== Target Platform & Dependency Resolution ===
  
 
<ul>
 
<ul>
<li>A new packaging type [[Tycho/Packaging Types#eclipse-target-definition|"eclipse-target-definition"]] for PDE target definitions has been added
+
<li>There is a new packaging type [[Tycho/Packaging Types#eclipse-target-definition|<tt>eclipse-target-definition</tt>]] for adding a PDE target definition file (<tt>*.target</tt>) to the build. In order to use the target file as [[Tycho/Target Platform|target platform]], add a reference to it in the [[Tycho/Target Platform#Target files|target platform configuration]].
 
</li>
 
</li>
<li>Providing [[Tycho/Target Platform/Authentication and Mirrors#Credentials|credentials for a p2 repository]] specified in a target file is now more convenient – the use of the non-standard <tt>id</tt> attribute in target files is no longer necessary (<strike>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=377086 bug 377086]</strike>).
+
<li>The new property [[Tycho/Target Platform#Locally built artifacts|<tt>tycho.localArtifacts</tt>]] allows to control whether artifacts installed in the local Maven repository by previous Tycho builds should be considered by the resolver or not. The property can be specified on the command line and in the settings.xml:
 +
  <ul>
 +
    <li>If unset (or set to <tt>default</tt>), the behaviour is unchanged (local metadata is considered by the resolver, and there is a warning if locally built units were used)</li>
 +
    <li>If set to <tt>ignore</tt>, locally built artifact are ignored</li>
 +
  </ul>
 
</li>
 
</li>
<li>Access to p2 repository can be [[Tycho/Target Platform/Authentication and Mirrors#Mirrors|redirected to a mirror location]]. This now works for both target files and repositories specified in the POM (<strike>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=356016 bug 356016]</strike>).
+
<li>(INCOMPATIBLE CHANGE) The build now fails if one of the children of a composite p2 repository can't be loaded, e.g. because of a temporary network failure. Before, the build would have continued and may have passed, potentially producing a different build result.<br/>
</li>
+
<li>With Tycho 0.15, if a composite site was loaded as part of the target platform resolution for a build, and some of the child sites were missing, a warning would be logged but the build would continue. With Tycho 0.16.0, the build instead fails. To recover the old behaviour, add this property to your composite*.xml files. See also [https://issues.jboss.org/browse/JBIDE-12914], [https://bugs.eclipse.org/bugs/show_bug.cgi?id=356561#c52]:
+
<pre>&lt;property name="p2.atomic.composite.loading" value="false"/&gt;</pre>
+
</li>
+
<li> Added a property <tt>"tycho.localArtifacts"</tt> which allows to control whether artifacts installed in the local maven repository by previous tycho builds should be considered by the resolver or not. The property can be specified on the command line and in settings.xml. (See also [[Tycho/Target Platform#Locally built artifacts|this section]] in the target platform documentation.)
+
 
   <ul>
 
   <ul>
     <li>if unset (or set to "<tt>default</tt>"), the behaviour is unchanged (local metadata is considered by the resolver, and there is a warning if locally built units were used)</li>
+
     <li>Note that a composite p2 repository may still enforce the old behaviour by setting the repository property <tt>p2.atomic.composite.loading</tt> to <tt>false</tt>. Using these non-atomic composite p2 repositories in a production build is discouraged because they suffer from [https://bugs.eclipse.org/bugs/show_bug.cgi?id=356561 p2 bug 356561], which is threatening build reproducibility.</li>
    <li>if set to "<tt>ignore</tt>", locally built artifact are ignored</li>
+
 
   </ul>
 
   </ul>
 
</li>
 
</li>
<li>Basic support for [[Tycho/Execution Environments|custom execution environment profiles]] (<strike>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=385930 bug 385930]</strike>)
+
<li>Providing [[Tycho/Target Platform/Authentication and Mirrors#Credentials|credentials for a p2 repository]] specified in a target file is now more convenient – the use of the non-standard <tt>id</tt> attribute in target files is no longer necessary (<strike>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=377086 bug 377086]</strike>).
 +
</li>
 +
<li>Access to p2 repository can be [[Tycho/Target Platform/Authentication and Mirrors#Mirrors|redirected to a mirror location]]. This now works for both target files and repositories specified in the POM (<strike>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=356016 bug 356016]</strike>).
 +
</li>
 +
<li>There is now basic support for [[Tycho/Execution Environments|custom execution environment profiles]] (<strike>[https://bugs.eclipse.org/bugs/show_bug.cgi?id=385930 bug 385930]</strike>)
 
</li>
 
</li>
 
<li>A new plugin to validate target platforms. This plugin takes as input one or several target platforms and ensures they can be resolved, fails otherwise
 
<li>A new plugin to validate target platforms. This plugin takes as input one or several target platforms and ensures they can be resolved, fails otherwise
Line 72: Line 74:
 
&lt;/plugin&gt;
 
&lt;/plugin&gt;
 
</pre>
 
</pre>
Executing tests in parallel can be useful e.g. if you have long-running integration tests which are not CPU-bound.<br> Under the hood, this feature was enabled by porting the junit4.7 surefire provider to Tycho.
+
Executing tests in parallel can be useful e.g. if you have long-running integration tests which are not CPU-bound. Under the hood, this feature was enabled by porting the junit4.7 surefire provider to Tycho.
 
</li>
 
</li>
 
<li>Support for test frameworks is extensible now. This means you can add support for test frameworks other than JUnit if you provide an implementation of [http://git.eclipse.org/c/tycho/org.eclipse.tycho.git/tree/tycho-surefire/tycho-surefire-plugin/src/main/java/org/eclipse/tycho/surefire/provider/spi/TestFrameworkProvider.java TestFrameworkProvider].
 
<li>Support for test frameworks is extensible now. This means you can add support for test frameworks other than JUnit if you provide an implementation of [http://git.eclipse.org/c/tycho/org.eclipse.tycho.git/tree/tycho-surefire/tycho-surefire-plugin/src/main/java/org/eclipse/tycho/surefire/provider/spi/TestFrameworkProvider.java TestFrameworkProvider].
Line 86: Line 88:
 
=== Other ===
 
=== Other ===
  
* If several tycho versions were inadvertently mixed within the same reactor, this could lead to cryptic errors like ClassCastExceptions. This situation is now detected early and the build will fail with a clear error message
+
* If several tycho versions were inadvertently mixed within the same reactor, this could lead to cryptic errors like ClassCastExceptions. This situation is now detected early and the build will fail with a clear error message.
  
 
[[Category:Tycho|Release Notes/0.16]]
 
[[Category:Tycho|Release Notes/0.16]]

Revision as of 07:44, 10 April 2013

New and Noteworthy

Complete list of bug fixes and enhancements in 0.16.0

Compiler

Target Platform & Dependency Resolution

  • There is a new packaging type eclipse-target-definition for adding a PDE target definition file (*.target) to the build. In order to use the target file as target platform, add a reference to it in the target platform configuration.
  • The new property tycho.localArtifacts allows to control whether artifacts installed in the local Maven repository by previous Tycho builds should be considered by the resolver or not. The property can be specified on the command line and in the settings.xml:
    • If unset (or set to default), the behaviour is unchanged (local metadata is considered by the resolver, and there is a warning if locally built units were used)
    • If set to ignore, locally built artifact are ignored
  • (INCOMPATIBLE CHANGE) The build now fails if one of the children of a composite p2 repository can't be loaded, e.g. because of a temporary network failure. Before, the build would have continued and may have passed, potentially producing a different build result.
    • Note that a composite p2 repository may still enforce the old behaviour by setting the repository property p2.atomic.composite.loading to false. Using these non-atomic composite p2 repositories in a production build is discouraged because they suffer from p2 bug 356561, which is threatening build reproducibility.
  • Providing credentials for a p2 repository specified in a target file is now more convenient – the use of the non-standard id attribute in target files is no longer necessary (bug 377086).
  • Access to p2 repository can be redirected to a mirror location. This now works for both target files and repositories specified in the POM (bug 356016).
  • There is now basic support for custom execution environment profiles (bug 385930)
  • A new plugin to validate target platforms. This plugin takes as input one or several target platforms and ensures they can be resolved, fails otherwise
    <plugin>
       <groupId>org.eclipse.tycho.extras</groupId>
       <artifactId>target-platform-validation-plugin</artifactId>
       <version>${tychoExtrasVersion}</version>
       <executions>
          <execution>
             <phase>validate</phase>
             <goals>
                <goal>validate-target-platform</goal>
             </goals>
             <configuration>
                <targetFiles>
                   <param>indigo.target</param>
                   <param>juno.target</param>
                </targetFiles>
                <failOnError>true</failOnError>
             </configuration>
          </execution>
       </executions>
    </plugin>

Test Execution

  • Support for parallel test execution with JUnit >= 4.7 has been added.
    If you use Junit >= 4.7, you can now have test classes or methods executed by several threads in parallel by adding -Dparallel=classes|methods|both on the commandline or by configuring
    <plugin>
       <groupId>org.eclipse.tycho</groupId>
       <artifactId>tycho-surefire-plugin</artifactId>
       <version>${tycho-version}</version>
       <configuration>
         <parallel>classes|methods|both</parallel>
       </configuration>
    </plugin>
    

    Executing tests in parallel can be useful e.g. if you have long-running integration tests which are not CPU-bound. Under the hood, this feature was enabled by porting the junit4.7 surefire provider to Tycho.

  • Support for test frameworks is extensible now. This means you can add support for test frameworks other than JUnit if you provide an implementation of TestFrameworkProvider.

Packaging

Other

  • If several tycho versions were inadvertently mixed within the same reactor, this could lead to cryptic errors like ClassCastExceptions. This situation is now detected early and the build will fail with a clear error message.