Skip to content

TIKA-4733 -- improve release artifact robustness and documentation#2825

Open
tballison wants to merge 1 commit into
mainfrom
TIKA-4733
Open

TIKA-4733 -- improve release artifact robustness and documentation#2825
tballison wants to merge 1 commit into
mainfrom
TIKA-4733

Conversation

@tballison
Copy link
Copy Markdown
Contributor

Thanks for your contribution to Apache Tika! Your help is appreciated!

Before opening the pull request, please verify that

  • there is an open issue on the Tika issue tracker which describes the problem or the improvement. We cannot accept pull requests without an issue because the change wouldn't be listed in the release notes.
  • the issue ID (TIKA-XXXX)
    • is referenced in the title of the pull request
    • and placed in front of your commit messages surrounded by square brackets ([TIKA-XXXX] Issue or pull request title)
  • commits are squashed into a single one (or few commits for larger changes)
  • Tika is successfully built and unit tests pass by running ./mvnw clean test
  • there should be no conflicts when merging the pull request branch into the recent main branch. If there are conflicts, please try to rebase the pull request branch on top of a freshly pulled main branch
  • if you add new module that downstream users will depend upon add it to relevant group in tika-bom/pom.xml.

We will be able to faster integrate your pull request if these conditions are met. If you have any questions how to fix your problem or about using Tika in general, please sign up for the Tika mailing list. Thanks!

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR (TIKA-4733) tightens release/distribution handling for Tika 4.x artifacts and updates CLI messaging/docs to better reflect the “zip distribution with lib/” packaging model.

Changes:

  • Drop the redundant -bin.tgz server distribution, standardizing on .zip.
  • Prevent selected distribution zips from being attached/deployed to Maven Central (attach=false) and add release-staging checks to fail fast if expected dist artifacts are missing.
  • Improve tika-app batch/async invocation behavior with a clearer error message and update CLI documentation/examples accordingly.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
tika-server/tika-server-standard/src/main/assembly/assembly.xml Removes tgz output format, leaving zip as the distribution format.
tika-server/tika-server-standard/pom.xml Sets attach=false for the server bin assembly and adds an install step intended to satisfy downstream consumption.
tika-eval/tika-eval-app/pom.xml Sets attach=false for the eval app distribution zip.
tika-app/src/main/java/org/apache/tika/cli/TikaCLI.java Wraps async/batch invocation to translate NoClassDefFoundError into a user-actionable message.
tika-app/pom.xml Sets attach=false for the tika-app distribution zip.
pom.xml Adds explicit “missing artifact” failures during apache-release staging and validates pipes plugin zip staging count.
docs/modules/ROOT/pages/using-tika/cli/index.adoc Updates CLI docs to reflect zip-based distribution and batch mode usage via tika-app.jar.
docs/modules/ROOT/pages/pipes/parse-modes.adoc Updates CLI examples to use tika-app.jar for batch processor usage.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +208 to +215
deployed to Central nor installed locally. Sibling reactor modules
declare tika-server-standard:bin:zip as a Maven dep, so install it
into the local repo at its canonical coordinates to satisfy reactor
resolution without publishing it to Central.
-->
<execution>
<id>install-server-bin-zip-locally</id>
<phase>install</phase>
+ "standalone jar.");
System.err.println("Download tika-app-<version>.zip, unzip it, and run "
+ "tika-app-<version>.jar from inside the unzipped directory so that the "
+ "adjacent 'lib/' and 'plugins/' directories are on the classpath.");
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