linuxdeepin/Document check
An action to check document
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stalelast commit Dec 13, 2023
- License
- None
Pinned Snippet
uses: linuxdeepin/action-doxygencheck@cd97488be0e659569e972b780fdc114270543ac4 # no releases — HEAD as of 2026-07-11tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| pullRequestId | pull request id | yes | — |
| checkKind | kind to check | no | all |
| checkScope | comma-separated list of item scopes to include | — | public |
| checkedSuffix | which file suffix will be checked | — | .cpp,.h,.c,.hpp,.cxx,.hxx |
| installDepends | install all build depends | no | false |
| installCoverxygen | install coverxygen | no | true |
| installDoxygen | install doxygen | no | true |
| setFailed | set action failed or not while can't pass check | — | true |
| genDocCommand | command to gen document | no | cmake -Bbuild -DDOXYGEN_GENERATE_XML=1 . cmake --build build --target doxygen python3 -m coverxygen --xml-dir=./build/docs/xml --src-dir . --format json --kind $CHECK_KIND --scope $CHECK_SCOPE --output $CHECK_RES |
Outputs
no outputs