LUCENE-9333: Add gradle task to compile changes.txt to a html #1468
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds "documentation" gradle task (equivalent of ant's "documentation") and its sub task "changesToHtml" (equivalent of ant's "changes-to-html" that compiles CHANGES.txt into Changes.html).
The output directories are
lucene/build/documentation
(for lucene) andsolr/build/documentation
(for solr). Those are not used by ant; ant outputs docs intolucene/build/docs
andsolr/build/docs
."documentation" task is incomplete for now; please see the TODO comment.
Gradle command
or
Tests
I checked md5 hash for the compiled Changes.html to verify the gradle task generates exact same file as ant (when version property is set to
9.0.0
).Note about RDF processing
Not fully sure, but there is no equivalent gradle task for
ant.xmlproperties
as far as I know.We could remove the ant call by writing our custom XPath processor which will be built on groovy's XmlSluper. I didn't do so here but just cloned the original Ant task. To me it would be preferable to replace the DOAP RDF with a JSON (or simply a CSV) instead of adding another XML processing code, if we want to completely drop the ant convention. ?