You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by sc...@apache.org on 2017/02/13 17:58:30 UTC
svn commit: r1782819 - in /uima/uimaj/trunk: api-change-report.html pom.xml
src/main/assembly/bin-without-jackson.xml src/main/assembly/bin.xml
Author: schor
Date: Mon Feb 13 17:58:30 2017
New Revision: 1782819
URL: http://svn.apache.org/viewvc?rev=1782819&view=rev
Log:
[UIMA-5307] for binary builds, output api compatibility report at the top level, aggregated, using a custom html page; don't copy the reports.
Added:
uima/uimaj/trunk/api-change-report.html
Modified:
uima/uimaj/trunk/pom.xml
uima/uimaj/trunk/src/main/assembly/bin-without-jackson.xml
uima/uimaj/trunk/src/main/assembly/bin.xml
Added: uima/uimaj/trunk/api-change-report.html
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/api-change-report.html?rev=1782819&view=auto
==============================================================================
--- uima/uimaj/trunk/api-change-report.html (added)
+++ uima/uimaj/trunk/api-change-report.html Mon Feb 13 17:58:30 2017
@@ -0,0 +1,60 @@
+ <!--
+ ***************************************************************
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ ***************************************************************
+ -->
+<html>
+<head>
+ <title>API Change Report - Apache UIMA</title>
+</head>
+<body>
+<h1>Apache UIMA (Unstructured Information Management Architecture) API Change Report</h1>
+
+<h2>Contents</h2>
+<p>
+<a href="#description">What is an API change report?</a><br/>
+<a target="_blank" href="uimaj-core/api-change-report/japicmp.html">API Changes: uimaj-core</a><br/>
+<a target="_blank" href="uimaj-cpe/api-change-report/japicmp.html">API Changes: uimaj-cpe</a><br/>
+<a target="_blank" href="uimaj-json/api-change-report/japicmp.html">API Changes: uimaj-json</a><br/>
+<a href-"#running-more-reports">Running your own custom reports</a>
+</p>
+
+<h2><a id="description">What is an API change report?</a></h2>
+
+ <p>
+ Three of the modules in the UIMA Java SDK track API changes from version to version.
+ The changes between this current version and the last previously released version are
+ reported below. Each report includes a summary of Classes that were changed, together with
+ a flag indicating if the change was a source or binary incompatible change.
+ More details about each change are available further down in the report.
+ </p>
+
+ <p>
+ Follow the links above to get the report for each of the 3 modules.
+ </p>
+
+
+<h2><a id="running-more-reports">Running additional change reports</a></h2>
+<p>The reports are generated by an open source tool,
+<a target="_blank" href="http://siom79.github.io/japicmp/">japicmp</a>, which compares two versions of
+a Java Jar and generates the report. See that website for details on how to run this for arbitrary versions, if you
+want to compare other versions.
+</p>
+
+</body>
+</html>
\ No newline at end of file
Modified: uima/uimaj/trunk/pom.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/pom.xml?rev=1782819&r1=1782818&r2=1782819&view=diff
==============================================================================
--- uima/uimaj/trunk/pom.xml (original)
+++ uima/uimaj/trunk/pom.xml Mon Feb 13 17:58:30 2017
@@ -284,35 +284,8 @@
</execution>
</executions>
</plugin>
-
- <!-- This copy is to have the api change report included in the source distribution -->
- <plugin>
- <artifactId>maven-antrun-plugin</artifactId>
- <executions>
- <execution>
- <id>copy-API-change-report</id>
- <phase>prepare-package</phase> <!-- must precede package -->
- <goals><goal>run</goal></goals>
- <configuration>
- <target>
- <copy toDir="${basedir}/api-change-report/uimaj-core">
- <fileset dir="${basedir}/uimaj-core/api-change-report"/>
- </copy>
- <copy toDir="${basedir}/api-change-report/uimaj-cpe">
- <fileset dir="${basedir}/uimaj-cpe/api-change-report"/>
- </copy>
- <copy toDir="${basedir}/api-change-report/uimaj-json">
- <fileset dir="${basedir}/uimaj-json/api-change-report"/>
- </copy>
-
- </target>
- </configuration>
- </execution>
- </executions>
-
- </plugin>
-
- </plugins>
+
+ </plugins>
</build>
<profiles>
Modified: uima/uimaj/trunk/src/main/assembly/bin-without-jackson.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/src/main/assembly/bin-without-jackson.xml?rev=1782819&r1=1782818&r2=1782819&view=diff
==============================================================================
--- uima/uimaj/trunk/src/main/assembly/bin-without-jackson.xml (original)
+++ uima/uimaj/trunk/src/main/assembly/bin-without-jackson.xml Mon Feb 13 17:58:30 2017
@@ -275,12 +275,12 @@ under the License.
<!-- Copy the API Change reports -->
<fileSet>
<directory>uimaj-core/api-change-report</directory>
- <outputDirectory>api-change-reports/uimaj-core</outputDirectory>
+ <outputDirectory>uimaj-core/api-change-report</outputDirectory>
<fileMode>644</fileMode>
</fileSet>
<fileSet>
<directory>uimaj-cpe/api-change-report</directory>
- <outputDirectory>api-change-reports/uimaj-cpe</outputDirectory>
+ <outputDirectory>uimaj-cpe/api-change-report</outputDirectory>
<fileMode>644</fileMode>
</fileSet>
@@ -333,5 +333,9 @@ under the License.
<outputDirectory>examples/ecore_src/org/apache/uima/examples/xmi</outputDirectory>
<fileMode>644</fileMode>
</file>
+ <file>
+ <source>api-change-report.html</source>
+ <outputDirectory>.</outputDirectory>
+ </file>
</files>
</assembly>
\ No newline at end of file
Modified: uima/uimaj/trunk/src/main/assembly/bin.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/src/main/assembly/bin.xml?rev=1782819&r1=1782818&r2=1782819&view=diff
==============================================================================
--- uima/uimaj/trunk/src/main/assembly/bin.xml (original)
+++ uima/uimaj/trunk/src/main/assembly/bin.xml Mon Feb 13 17:58:30 2017
@@ -298,17 +298,17 @@ under the License.
<!-- Copy the API Change reports -->
<fileSet>
<directory>uimaj-core/api-change-report</directory>
- <outputDirectory>api-change-reports/uimaj-core</outputDirectory>
+ <outputDirectory>uimaj-core/api-change-report</outputDirectory>
<fileMode>644</fileMode>
</fileSet>
<fileSet>
<directory>uimaj-cpe/api-change-report</directory>
- <outputDirectory>api-change-reports/uimaj-cpe</outputDirectory>
+ <outputDirectory>uimaj-cpe/api-change-report</outputDirectory>
<fileMode>644</fileMode>
</fileSet>
<fileSet>
<directory>uimaj-json/api-change-report</directory>
- <outputDirectory>api-change-reports/uimaj-json</outputDirectory>
+ <outputDirectory>uimaj-json/api-change-report</outputDirectory>
<fileMode>644</fileMode>
</fileSet>
</fileSets>
@@ -359,5 +359,9 @@ under the License.
<outputDirectory>examples/ecore_src/org/apache/uima/examples/xmi</outputDirectory>
<fileMode>644</fileMode>
</file>
+ <file>
+ <source>api-change-report.html</source>
+ <outputDirectory>.</outputDirectory>
+ </file>
</files>
</assembly>
\ No newline at end of file