jameskomo/DocsWatcher

Find the external APIs your code calls that already have a shutdown date.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
pathDirectory to scan. Point at a subdirectory in a monorepo.no.
fail-onbreaking fails the build on a dated shutdown; never reports without failing.nobreaking
include-lowAlso report contracts found only in documentation or test files.nofalse
excludePaths 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""
knowledgeDirectories 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""
reportWrite the full JSON findings to this path.no""
versionRelease tag to use. Defaults to the latest release.nolatest
namedescription
findingsTotal findings.
breakingFindings whose shutdown date has passed or is scheduled.
reportPath to the JSON report, when the report input was set.