fortify-ps / FortifyBugTrackerUtility

Automated submission of FoD and SSC vulnerabilities to external systems
MIT License
25 stars 14 forks source link

Improve usage documentation #78

Open rsenden opened 3 months ago

rsenden commented 3 months ago

Enhancement Request

Current documentation focuses on configuration options; there's some generic usage documentation, but users need to run the utility to see all supported command-line options for a given configuration for example. It would be good to have the documentation list all supported command-line options (either by configuration file, or by source/target system).

In the simplest form, we could have a 'Command-line Options' section containing sub-sections for each provided configuration file like FoDToJira.xml or SSCToOctane.xml, with each of those sub-sections showing the output of the -help option for that particular configuration file. Primary question is how we can integrate this into the Maven-based build process; potentially we may need to convert to a Gradle-based build for more flexibility.