DependencyTrack / dependency-track

Dependency-Track is an intelligent Component Analysis platform that allows organizations to identify and reduce risk in the software supply chain.
https://dependencytrack.org/
Apache License 2.0
2.45k stars 532 forks source link

Generate config documentation from `application.properties` #3768

Open nscuro opened 1 month ago

nscuro commented 1 month ago

Description

Generates config documentation from application.properties.

Leverages the GenerateConfigDocs JBang script (https://github.com/DependencyTrack/jbang-catalog/blob/main/GenerateConfigDocs.java) to generate reference documentation from the application.properties file.

This makes application.properties the single source of truth for configuration options. We no longer need to copy-paste its contents to multiple places for documentation purposes.

The documentation is re-generated automatically whenever application.properties changes.

This is already done for the Hyades project (https://github.com/DependencyTrack/hyades/blob/2f95363fbf51423876a8eb2c7f0bc55a53ba85f9/DEVELOPING.md?plain=1#L11-L61) and turned out to be useful, so backporting it here.

Addressed Issue

N/A

Additional Details

N/A

Checklist