-
Notifications
You must be signed in to change notification settings - Fork 100
Migrate to dita-ot-gradle plugin v2.8.2 #660
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.
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
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll strip these unnecessary comment remnants after merging.
@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