actions-marketplace-validations/Document CMake options
GitHub Actions for automatically documenting all cmake options which specify the build.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stalelast commit Jun 16, 2023
- License
- MIT
Pinned Snippet
uses: actions-marketplace-validations/cpp977_gencmakedoc@aae587f3512b25bc6cd551eadcb4ea6d1fc86dae # no releases — HEAD as of 2026-07-13tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| source_dir | Set the directory of the sources. Normally your github repository. | yes | — |
| option_filter | Specify a filter for cmake options to process. For getting options like MYLIB_SOME_OPT, set filter to MYLIB. If empty, no filter is applied. | no | "" |
| heading_marker | Markdown specifier for the heading of the section which contains the documentation of cmake build options. | no | # |
| heading_title | Title of the section which contains the documentation of cmake build options. | no | Build Options |
| readme_name | Filename of the README file relative to source_dir. | no | README.md |
| configure_opts | Options which are passed to the cmake configure call. Format: <OPT1>=<VAL1> <OPT2>=<VAL2> ... | no | "" |
Outputs
no outputs