Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Generate config documentation from application.properties #3768

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Generate config documentation from application.properties #3768

wants to merge 1 commit into from
+3,342 −773

Commits on Sep 19, 2024

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

Signed-off-by: nscuro <[email protected]>
    @nscuro
    nscuro committed Sep 19, 2024
    Configuration menu
    Copy the full SHA
    ee993a8 View commit details
    Browse the repository at this point in the history