Philipp Ottlinger created RAT-374:
-------------------------------------

             Summary: Automatically output RAT CLI's help options during the 
build and add it to the project webpage
                 Key: RAT-374
                 URL: https://issues.apache.org/jira/browse/RAT-374
             Project: Apache Rat
          Issue Type: Improvement
    Affects Versions: 0.16.1
            Reporter: Philipp Ottlinger


At the moment there are plenty of places that need to be changed when a new CLI 
option is added or an existing one is changed, e.g.
* https://github.com/apache/creadur-rat/blob/master/apache-rat/README-CLI.txt
* https://github.com/apache/creadur-rat/blob/master/apache-rat/README-ANT.txt
* 
https://github.com/apache/creadur-rat/blob/master/apache-rat/src/site/apt/index.apt.vm

Generating the current version of CLI options directly from RAT's sources would 
be much easier for further development and to keep the docs in sync with the 
code:
https://creadur.apache.org/rat/apache-rat/index.html

Not sure if this task can be accomplished with the help of
* maven-antrun
* maven-exec 
or other means, but the desired state is less manual change in case of 
CLI/option changes.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to