Migrate to dita-ot-gradle plugin v2.8.2#660
Conversation
- Update dita-ot-gradle plugin from v2.3.2 to v2.8.1 to benefits major improvment - Enable Configuration Cache for faster incremental builds - Add new verification tasks: validateDita and checkLinks Co-authored-by: Jeremy Jeanne <jeremy.jeanne@4dconcept.fr> Signed-off-by: Jeremy Jeanne <jeremy.jeanne@4dconcept.fr>
There was a problem hiding this comment.
@jyjeanne 🙏 Thanks for submitting this. Interesting ideas here.
Makes sense to strip the comments from our earlier work on the build file.
Certainly much cleaner without them. 👍
I ran the docs build with these changes, and output was generated as expected, so it still works with these changes.
The additional progress indicators look useful:
Starting DITA-OT transformation
[==> ] 10% - Preprocessing
[====================> ] 70% - Transforming (45 files)
[=======================> ] 80% - Generating content (77 files)
The PDF transformation is much noisier now, as it logs all sorts of FOP warnings:
[WARN] The contents of fo:region-body on page 1 exceed its viewport by 48187 millipoints. (See position 1:1663)
[WARN] Property ID "unique_348" (found on "fo:wrapper") previously used; ID values must be unique within a document! Any reference to it will be considered a reference to the first occurrence in the document. (See position 12569:685)
[WARN] table-layout="fixed" and column-width unspecified => falling back to proportional-column-width(1) (See position 12605:5143)
[WARN] The following feature isn't implemented by Apache FOP, yet: table-layout="auto" (on fo:table) (See position 12966:2236)
While this level of detail is useful in debugging scenarios, I would expect it to be configurable, and not shown by default.
Note
See additional code comments in context below ↓
P.S. For future reference: it would be better to submit PRs from dedicated feature branches, rather than from the develop branch in your fork. This helps to isolate the proposed changes from any other changes that may land on the upstream develop branch in the meantime.)
@infotexture You're right - the FOP warnings are useful for debugging but shouldn't be displayed by I will add a showWarnings property that controls whether warnings are displayed during transformation. The default is false |
Fix accidental removal during refactoring. This block moves .chm files from htmlhelp/ subdirectory to output root and cleans up." Co-authored-by: Jeremy Jeanne <jeremy.jeanne@4dconcept.fr> Signed-off-by: Jeremy Jeanne <jeremy.jeanne@4dconcept.fr>
|
@infotexture All review comments from have been addressed.
Best regards |
- DitaOtValidateTask has false positive issues on generated files - Use native 'dita validate' subcommand for validation instead Co-authored-by: Jeremy Jeanne <jeremy.jeanne@4dconcept.fr> Signed-off-by: Jeremy Jeanne <jeremy.jeanne@4dconcept.fr>
infotexture
left a comment
There was a problem hiding this comment.
I'll squash this to the release branch.
Thanks for your efforts. 🙇
| // ============================================================================= | ||
| // Verification Tasks (v2.8.1 features) | ||
| // ============================================================================= | ||
|
|
||
| // ============================================================================= | ||
| // Aggregate Tasks | ||
| // ============================================================================= | ||
|
|
There was a problem hiding this comment.
I'll strip these unnecessary comment remnants after merging.
* release/4.4: (61 commits) Move URI dependency tracking info to enhancements Update & remove comments from build file Bump jyjeanne/dita-ot-gradle from 2.3.2 to 2.8.2 (#660) Add entries for recently resolved issues in 4.4 Combine entries for HTML5 passthrough changes Add entries for recently resolved issues in 4.4 List updated docs topics in 4.4 Remove mark highlight from release summary Bump Saxon-HE to version 12.9 Update contributors lists based on latest commits Add 4.4 migration topic & re-use DITA 2.0 info Add previous release dates to 2.0 spec support Move DITA 2.0 updates to spec support for re-use Mark publish.required.cleanup as deprecated Add missing issue link Fix keyref for 2025 new features video topic Edit 2025 video descriptions Push deprecation details to `outputFile.base` #648 Simplify and align deprecation references Mark deprecated elements in HTML output ...
DITA-OT 4.4 # -----BEGIN PGP SIGNATURE----- # # iQIzBAABCAAdFiEE4dwAszXsmTZ/8urXv5ed07nfjisFAml+G1YACgkQv5ed07nf # jiuIxw//eCX4UL/OFA4gekaEAiazIkYBzWMZ/AEJMOXgdfVRgMWeG/tPlfl/crkP # cA18+xQDxT1HFjNGXE0aFQUNzuOZKxa5yR4NexabyaeX9FDgL1m6Dgvh9+U25Efw # L3P3bkA9nm7V9ixNX4rr3UjZx26EjObki9pPPhPkiL9OEBzgEf2QSz+LyEht4Lom # ikwF8GWYH24h/9V5YTBZs8leaW19Vp8YI2h+x1fD0+r3ihdspSNrn+m23/z7DzKh # XdohRkqwDmMz39l0qtp/SqOT9uHgLkkt/EzL3OVtD+3BOhX/XCxC94Z91UpyoRIw # WLUugj/IP88x14tprUm0DjMvSU6sAdCnBypAGlqjgKm8vmCKWZX+8PXT1hXm8NxF # qvfUEK3uQrWWwXxlVZOASKbSRSDcjArcbbY/mxsoEAGy5ddSW2h5vjd5nfGqsxpL # 3vPMsvZm316uPvmr2gC0wV7wTTSQu4CAYXsxMzmYl2H4XXGwutw2LDj2EnED1QYl # PmKj9sC5Wfz5SNZHNd/CKwfOdfuNUbN4weAP5bpEMHhhdHzOKcXduQp1HjXnJVyA # Xms27r3QRUtA1nUrg9/++U4arCluzWR8AzQO4f541UZV3W6miTViKCeU2u8hSQvD # G7CsFKnklbF8SbE06aXFfg0XMV4fotCAcNiYuodolIZ6lTuireo= # =mf8H # -----END PGP SIGNATURE----- # gpg: Signature made Sat Jan 31 16:10:14 2026 CET # gpg: using RSA key E1DC00B335EC99367FF2EAD7BF979DD3B9DF8E2B # gpg: Good signature from "Roger Sheen <roger@infotexture.net>" [ultimate] * tag '4.4': (36 commits) Move URI dependency tracking info to enhancements Update & remove comments from build file Bump jyjeanne/dita-ot-gradle from 2.3.2 to 2.8.2 (#660) Add entries for recently resolved issues in 4.4 Combine entries for HTML5 passthrough changes Add entries for recently resolved issues in 4.4 List updated docs topics in 4.4 Remove mark highlight from release summary Bump Saxon-HE to version 12.9 Update contributors lists based on latest commits Add 4.4 migration topic & re-use DITA 2.0 info Add previous release dates to 2.0 spec support Move DITA 2.0 updates to spec support for re-use Mark publish.required.cleanup as deprecated Add missing issue link Fix keyref for 2025 new features video topic Edit 2025 video descriptions Push deprecation details to `outputFile.base` #648 Simplify and align deprecation references Mark deprecated elements in HTML output ...
@infotexture ## Key Changes
dita-ot-gradleplugin from v2.3.2 to v2.8.1 to benefits new improvmentsvalidateDitaandcheckLinksMotivation and Context
Gradle 9.0 removes several deprecated APIs and makes Configuration Cache the recommended execution mode.
This PR ensures the documentation build works with Gradle 8.x, 9.x, and future versions, while enabling up to 77% faster incremental builds via Configuration Cache.
How Has This Been Tested?
./gradlew help --warning-mode all./gradlew --configuration-cache./gradlew dist -PditaHome=..../gradlew cleanOutput distFull Build Tested with DITA-OT 4.3.5
Type of Changes
Documentation and Compatibility
Documentation Changes
Backwards Compatibility
New Features
validateDita./gradlew validateDitacheckLinks./gradlew checkLinksverify./gradlew verifyChecklist
--warning-mode all