sebrandon1/OCP Documentation Checker
Check if OpenShift Container Platform documentation URLs are outdated
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| url | OCP documentation URL to check (mutually exclusive with paths) | no | — |
| paths | Space-separated list of files or directories to scan for OCP URLs (mutually exclusive with url). Defaults to current directory if not specified. | no | — |
| fail-on-outdated | Fail the action if documentation is outdated | no | true |
| all-available | Show all available newer versions (default: latest only) | no | false |
| verbose | Enable verbose output | no | false |
| fix | Automatically fix outdated URLs in files (only works with paths, not single URL) | no | false |
Outputs
| name | description |
|---|---|
| is-outdated | Whether the documentation is outdated (true/false). For batch mode, true if any URLs are outdated. |
| latest-version | The latest version where the documentation exists (single URL mode only) |
| newer-versions | JSON array of newer versions where the documentation exists (single URL mode only) |
| outdated-count | Number of outdated URLs found (batch mode only) |
| uptodate-count | Number of up-to-date URLs found (batch mode only) |
| total-count | Total number of URLs checked (batch mode only) |