You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tika.apache.org by "tballison (via GitHub)" <gi...@apache.org> on 2026/06/01 12:47:25 UTC
[PR] TIKA-4743 -- fix search result links [tika]
tballison opened a new pull request, #2860:
URL: https://github.com/apache/tika/pull/2860
<!--
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.
-->
Thanks for your contribution to [Apache Tika](https://tika.apache.org/)! Your help is appreciated!
Before opening the pull request, please verify that
* there is an open issue on the [Tika issue tracker](https://issues.apache.org/jira/projects/TIKA) 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](http://tika.apache.org/mail-lists.html). Thanks!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@tika.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] TIKA-4743 -- fix search result links [tika]
Posted by "Copilot (via GitHub)" <gi...@apache.org>.
Copilot commented on code in PR #2860:
URL: https://github.com/apache/tika/pull/2860#discussion_r3334247883
##########
docs/publish-docs.sh:
##########
@@ -83,6 +83,11 @@ cp target/site/404.html "${DOCS_DIR}/"
# Lunr index lives next to _/ (one level above docs/), since HTML uses ../../search-index.js.
# Remove the stale copy from its old publish/docs/ location left by earlier runs.
rm -f "${DOCS_DIR}/search-index.js"
-cp target/site/search-index.js "${PUBLISH_DIR}/"
+# Rewrite URLs in the search index from /tika/X.Y.Z/... (Antora's component-
+# prefixed publish path) to /docs/X.Y.Z/... (the deployed layout). The HTML
+# pages and sitemap.xml above are similarly flattened; without this rewrite,
+# clicking a search result lands on https://tika.apache.org/tika/... which
+# 404s. See TIKA-4743.
+sed 's|"url":"/tika/|"url":"/docs/|g' target/site/search-index.js > "${PUBLISH_DIR}/search-index.js"
Review Comment:
Because of shell redirection semantics, this command will truncate/create `${PUBLISH_DIR}/search-index.js` before `sed` runs. If `target/site/search-index.js` is missing or `sed` errors, the published search index can be left empty even though the script exits non-zero. Consider writing to a temporary file first (and explicitly failing with a clear message if the input file is missing) so a failed rewrite can’t corrupt an existing published index.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@tika.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] TIKA-4743 -- fix search result links [tika]
Posted by "tballison (via GitHub)" <gi...@apache.org>.
tballison merged PR #2860:
URL: https://github.com/apache/tika/pull/2860
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@tika.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] TIKA-4743 -- fix search result links [tika]
Posted by "Copilot (via GitHub)" <gi...@apache.org>.
Copilot commented on code in PR #2860:
URL: https://github.com/apache/tika/pull/2860#discussion_r3334465195
##########
docs/publish-docs.sh:
##########
@@ -61,6 +61,22 @@ if [[ ! -d target/site ]]; then
exit 1
fi
+# Run sed and replace $output atomically. The plain 'sed IN > OUT' form
+# truncates OUT before sed runs, so a missing input or sed failure leaves an
+# empty file behind; this writes to OUT.tmp first and only renames on success.
+# Important for PUBLISH_DIR/search-index.js, which persists across runs (a
+# corrupted one would stay corrupted until the next successful publish).
+sed_atomic() {
+ local script="$1" input="$2" output="$3"
+ if [[ ! -f "${input}" ]]; then
+ echo "${input} not found." >&2
+ echo "Re-run 'mvn package -pl docs' to regenerate it." >&2
+ exit 1
Review Comment:
The regeneration hint in this new error message suggests running `mvn package -pl docs`, but this script runs from `docs/` (and earlier in the script the build hint uses `cd .. && ./mvnw package -pl docs`). Using `mvn` directly may fail for contributors relying on the Maven wrapper and/or from the `docs/` directory; please align this message with the documented/earlier command.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@tika.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org