Skip to content

[I/Y-Build] Generalize API report generation and fix website links to it #3773

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HannesWell merged 1 commit into from
Apr 19, 2026
Merged

[I/Y-Build] Generalize API report generation and fix website links to it #3773

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 5 additions & 10 deletions JenkinsJobs/Builds/build.jenkinsfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,26 +346,21 @@ pipeline {
for filter in $(find ${AGG_DIR} -type f -path '*/.settings/.api_filters'); do
IFS='/' read -ra PATH_SEGMENTS <<< "${filter}"
pluginName="${PATH_SEGMENTS[-3]}"
target=${DROP_DIR}/${BUILD_ID}/apifilters/${pluginName}
target=${TEMP_DIR}/apifilters/${pluginName}
mkdir -p ${target}
cp ${filter} ${target}
done
pushd ${DROP_DIR}/${BUILD_ID}
zip -r apitools/apifilters-${BUILD_ID}.zip apifilters/*
popd

baseline=${DROP_DIR}/${BUILD_ID}/apitoolingreference/Eclipse-SDK-${PREVIOUS_RELEASE_VER}/eclipse-SDK-${PREVIOUS_RELEASE_VER}-win32-x86_64.zip
baseline=${TEMP_DIR}/apitoolingreference/repository-${PREVIOUS_RELEASE_VER}.zip
mkdir -p $(dirname ${baseline})
curl -o ${baseline} https://download.eclipse.org/eclipse/downloads/drops4/${PREVIOUS_RELEASE_ID}/eclipse-SDK-${PREVIOUS_RELEASE_VER}-win32-x86_64.zip
curl -o ${baseline} https://download.eclipse.org/eclipse/downloads/drops4/${PREVIOUS_RELEASE_ID}/repository-${PREVIOUS_RELEASE_VER}.zip
mvn tycho-eclipse:eclipse-run@generate-api-report -f eclipse-platform-parent \
-Declipserun.workArea=${TEMP_DIR}/apitoolings-logs \
-DgitRepoRoot=${AGG_DIR} \
-Dbaseline=${baseline} \
-Dcurrent_location=${DROP_DIR}/${BUILD_ID}/eclipse-SDK-${BUILD_ID}-win32-win32-x86_64.zip \
-Dcurrent_location=${PLATFORM_REPO_DIR} \
-Dreport=${DROP_DIR}/${BUILD_ID}/apitools \
-Dfilter_store=${DROP_DIR}/${BUILD_ID}/apifilters \

rm -rf ${DROP_DIR}/${BUILD_ID}/apitoolingreference
-Dfilter_store=${TEMP_DIR}/apifilters \

# Wait for notarization to complete before checksums are generated.
wait
Expand Down
2 changes: 1 addition & 1 deletion eclipse-platform-parent/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -546,7 +546,7 @@
<arg>-application</arg>
<arg>org.eclipse.ant.core.antRunner</arg>
<arg>-buildfile</arg>
<arg>${gitRepoRoot}/eclipse.platform.releng.tychoeclipsebuilder/eclipse/buildScripts/api-tools-builder.xml</arg>
<arg>${gitRepoRoot}/scripts/releng/apiReport/builder.xml</arg>
</applicationArgs>
<jvmArgs>
<arg>-Dbaseline=${baseline}</arg>
Expand Down
2 changes: 1 addition & 1 deletion ...clipse/buildScripts/api-tools-builder.xml → scripts/releng/apiReport/builder.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@

<property
name="exclude_list_external_location"
value="${basedir}/../apiexclude/exclude_list_external.txt" />
value="${basedir}/exclusions.txt" />

<!-- create HTML output directory -->
<property
Expand Down
7 changes: 7 additions & 0 deletions ...ipse/apiexclude/exclude_list_external.txt → scripts/releng/apiReport/exclusions.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,13 @@ com.ibm.icu
org.mortbay.jasper.mortbay-apache-jsp

## SPECIAL CASE FOR SWT: THE FRAGMENT IS ANALYZED AS PART OF THE HOST
org.eclipse.swt.cocoa.macosx.aarch64
org.eclipse.swt.cocoa.macosx.x86_64
org.eclipse.swt.gtk.linux.aarch64
org.eclipse.swt.gtk.linux.ppc64le
org.eclipse.swt.gtk.linux.riscv64
org.eclipse.swt.gtk.linux.x86_64
org.eclipse.swt.win32.win32.aarch64
org.eclipse.swt.win32.win32.x86_64
Comment on lines 25 to 33
Copy link
Copy Markdown
Member Author

@HannesWell HannesWell Apr 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm in doubt that the host org.eclipse.swt bundle is actually analyzed. At the same time, the supplied .api_filters files are also not correctly considered.
Therefore I'll leave this state as it is for now and postpone that investigation to a later point in time.


## Can't guarantee other Eclipse Projects bundles API stabiltiy
Expand Down
9 changes: 4 additions & 5 deletions sites/eclipse/build/reports.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,11 @@ <h3 id="logs">Logs</h3>
<li><a href="buildlogs/reporeports/index.html"><b>Repository Reports </b></a></li>
<li><a href="buildlogs/logs.html"><b>Build and Release Engineering Logs</b></a></li>
<li><a href="testresults/logs.html"><b>Test Console Logs</b></a></li>
<li><a href="apitools/analysis/html/index.html"><b>API Tools Version Verification Report</b></a>
This tool verifies the versions of the plugins against Eclipse ${previousReleaseAPILabel}
(Exclusions listed in <a href="https://github.com/eclipse-platform/eclipse.platform.releng.aggregator/blob//eclipse.platform.releng.tychoeclipsebuilder/eclipse/apiexclude/exclude_list_external.txt">apiexclude/exclude_list_external.txt</a>).
<li><a href="apitools/analysis/html/index.html"><b>API Verification Report</b></a><br>
API analysis of all Plug-ins against Eclipse ${previousReleaseAPILabel}<br>
(Exclusions listed in <a href="https://github.com/eclipse-platform/eclipse.platform.releng.aggregator/blob/master/scripts/releng/apiReport/exclusions.txt">apiReport/exclusions.txt</a>).
</li>
<li><a href="apitools/deprecation/apideprecation.html"><b>API Tools Deprecation Report</b></a> This tool generates a report for API deprecated since ${previousReleaseAPILabel}.</li>
<li><a href="apitools/apifilters-${label}.zip"><b>Zip of <samp>.api_filters</samp> files used in the build</b></a></li>
<li><a href="apitools/deprecation/apideprecation.html"><b>API Tools Deprecation Report</b></a> Listing of all API deprecations since ${previousReleaseAPILabel}.</li>
</ul>
<h3 id="tests">Unit Test Results</h3>
<p>The unit tests are run on the <a id="ci-tests-folder-url" href="https://ci.eclipse.org/releng">RelEng Jenkins instance</a>.</p>
Expand Down
Loading