[RAT-374] Automatically output RAT CLI's help options during the build and add it to the project webpage

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 0.16.1
• Fix Version/s: 0.17
• Assignee: Claude Warren
• Reporter: Philipp Ottlinger
• Created: 04/May/24 19:10
• Updated: 04/Jun/24 15:21
• Resolved: 21/May/24 09:52

Description

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.

Issue Links

• links to: GitHub Pull Request #253

Sub-Tasks

• Add accurate version info to the Command line parsing.: Resolved