hardmax71/Amiss Documentation Check
Checks documentation against the repository tree it describes and fails the run when a reference stops resolving.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| profile | observe (findings do not block) or enforce (blocking findings fail the run) | — | enforce |
| base | full base commit id; when empty, pull requests derive the candidate's first parent and other events read the payload | — | "" |
| candidate | full candidate commit id; derived from the triggering event when empty | — | "" |
| repo | path to the repository root inside the workspace | — | . |
| object-format | sha1 or sha256 | — | sha1 |
| annotations | emit candidate-located displayed Fixes and scan errors as file annotations | — | true |
| watchdog-seconds | wall-clock seconds the scan may take before it is ended with no result | — | 120 |
Outputs
| name | description |
|---|---|
| exit-class | the engine's exit class, 0, 1, or 2 |
| report | path to the machine report, one canonical JSON line |