Skip to content

Include source jar in BEAST.base and BEAST.app package zips#100

Merged
walterxie merged 1 commit into
masterfrom
feature/package-src-jar
Jun 18, 2026
Merged

Include source jar in BEAST.base and BEAST.app package zips#100
walterxie merged 1 commit into
masterfrom
feature/package-src-jar

Conversation

@alexeid

@alexeid alexeid commented Jun 18, 2026

Copy link
Copy Markdown
Member

What

Ship the module sources inside the BEAST.base and BEAST.app package zips, matching the previous BEAST2 layout (requested by Remco).

The source jar is placed at the zip root following the BEAST2 convention <PackageName>.src.jar:

BEAST.base.package.v*.zip
  version.xml
  BEAST.base.src.jar   ← new
  lib/…  examples/…

BEAST.app.package.v*.zip
  version.xml
  BEAST.app.src.jar    ← new
  lib/beast-fx-*.jar

How

maven-source-plugin (jar-no-fork) already produces a -sources.jar for every module in the package phase, ordered before the assembly execution. So each src/assembly/package.xml just adds a <file> entry that copies that jar to the zip root and renames it to <PackageName>.src.jar — no new build steps.

This is exactly the name and location that PackageHealthChecker.checkSourceCode() and the legacy installer in BeastLauncher already look for (source jar/zip at the package top level), so it satisfies the health check too. The src jar rides along automatically when the release scripts copy these zips into the bundle — no release-script changes needed.

Verified

Built both modules and confirmed the zips contain the src jar at the root: BEAST.base.src.jar (401 .java files) and BEAST.app.src.jar (197 .java files).

Match the BEAST2 package layout by shipping the module sources at the
zip root as <PackageName>.src.jar (BEAST.base.src.jar / BEAST.app.src.jar),
alongside version.xml. The -sources.jar is already produced by
maven-source-plugin (jar-no-fork) in the package phase, ordered before
the assembly execution, so each descriptor just copies it in and renames
it. This is the name/location PackageHealthChecker.checkSourceCode() and
the legacy installer already expect.
@walterxie walterxie merged commit fd3fede into master Jun 18, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants