bewee/Rustdoc coverage
Generate rustdoc coverage report
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
- Runtime
- Deprecated runtime
Inputs
| name | description | required | default |
|---|---|---|---|
| use-cross | Use cross instead of cargo | no | false |
| working-directory | Select a custom working directory | no | — |
| store-report | Whether to store the coverage report in rustdoc-coverage-report.json | no | true |
| calculate-diff | If a rustdoc-coverage-report.json exists: Whether to calculate the coverage diff to it | no | true |
| percentage-format | Format string used for percentages | yes | 0.[00]% |
| diff-percentage-format | Format string used for diff percentages | yes | +0.[00]% |
Outputs
| name | description |
|---|---|
| documented | The overall percentage of documented code |
| diff-documented | Difference in the overall percentage of documented code if a rustdoc-coverage-report.json exists and calculate-diff is enabled, otherwise zero |
| examples | The overall percentage of code with examples |
| diff-examples | Difference in the overall percentage of code with examples if a rustdoc-coverage-report.json exists and calculate-diff is enabled, otherwise zero |
| table | Tabular rustdoc coverage summary |
| json | JSON rustdoc coverage summary |