mocobeta opened a new pull request #1468:
URL: https://github.com/apache/lucene-solr/pull/1468


   # 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) and 
`solr/build/documentation` (for solr). Those are not used by ant; ant outputs 
docs into `lucene/build/docs` and `solr/build/docs`.
   
   "documentation" task is incomplete for now; please see the TODO comment.
   
   # 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`).
   
   ```
   lucene-solr $ md5sum lucene/build/docs/changes/Changes.html  # generate by 
ant
   e5ddb897e191915be0fe9f23bdd0edf0  lucene/build/docs/changes/Changes.html
   lucene-solr $ md5sum lucene/build/documentation/changes/Changes.html  # 
generated by gradle
   e5ddb897e191915be0fe9f23bdd0edf0  
lucene/build/documentation/changes/Changes.html
   ``` 
   
   ```
   lucene-solr $ md5sum solr/build/docs/changes/Changes.html  # generate by ant
   0076f4eb251c44a0b6effc9d8e958cd9  solr/build/docs/changes/Changes.html
   # Changes.html generated by gradle
   lucene-solr $ md5sum solr/build/documentation/changes/Changes.html  # 
generated by gradle
   0076f4eb251c44a0b6effc9d8e958cd9  
solr/build/documentation/changes/Changes.html
   ```
   
   # 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](https://docs.groovy-lang.org/latest/html/api/groovy/xml/XmlSlurper.html).
 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. ?
   


----------------------------------------------------------------
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.

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org
For additional commands, e-mail: issues-h...@lucene.apache.org

Reply via email to