RHsyseng / openshift-checks

A collection of scripts to check the health of an OpenShift cluster
53 stars 44 forks source link

feat: autogenerate checks.md out of descriptions in checks #120

Closed iranzo closed 1 year ago

iranzo commented 1 year ago

README gets removed the list of checks that goes into individual file checks.md

The checks.md file is autogenerated by a script, out of the headers of the individual checks.

As a side effect, the HTML interface now reports what each plugin does:

image

I would advise about doing headers like the ones in this plugin from now on: https://github.com/RHsyseng/openshift-checks/blob/main/checks/bz1948052#L1-L5

iranzo commented 1 year ago

Using a token it should be possible to commit back the checks.md file to the repo after each commit to the branch ;-)