jameskomo/DocsWatcher
Find the external APIs your code calls that already have a shutdown date.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| path | Directory to scan. Point at a subdirectory in a monorepo. | no | . |
| fail-on | breaking fails the build on a dated shutdown; never reports without failing. | no | breaking |
| include-low | Also report contracts found only in documentation or test files. | no | false |
| exclude | Paths to skip, one .gitignore-style pattern per line, for example `samples/`. The repository's .gitignore files and .docswatcherignore already apply; this is for one workflow. | no | "" |
| knowledge | Directories of your own API records to add to the knowledge base, one per line, relative to the workspace. Each holds providers/<id>/ in the knowledge base's format, for example a checkout of your organisation's .docswatcher repository. The scanned path's own .docswatcher/ is always read. Invalid records fail the step and name every error. See docs/19-your-own-apis.md. | no | "" |
| report | Write the full JSON findings to this path. | no | "" |
| version | Release tag to use. Defaults to the latest release. | no | latest |
Outputs
| name | description |
|---|---|
| findings | Total findings. |
| breaking | Findings whose shutdown date has passed or is scheduled. |
| report | Path to the JSON report, when the report input was set. |