magnu1102/OpenReady
Analyze GitHub repositories for portfolio readiness, gate CI on OpenReady scores, and generate score badges.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Jul 7, 2026
- License
- MIT
Pinned Snippet
uses: magnu1102/openready@c0272fbd736875dabec841587d3689a4bb4a4e0b # v0.5.5tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| username | GitHub username whose public repositories are analyzed | yes | — |
| repo | Focus a single repository by name (case-insensitive name or owner/name) | — | "" |
| token | GitHub token for API requests (avoids the ~60/hour unauthenticated limit) | — | ${{ github.token }} |
| fail-under | Fail the action if any analyzed repository scores below this (0-100) | — | "" |
| require-checks | Comma- or space-separated custom check ids that must pass for every repository | — | "" |
| profile | Path to an openready.profile.v1 JSON file | — | "" |
| limit | Maximum repositories to analyze | — | 30 |
| no-readme | Skip README fetches ("true" to enable) | — | false |
| no-tree | Skip file-tree fetches ("true" to enable) | — | false |
| report-path | Where to write the openready.export.v1 JSON report | — | openready-report.json |
| badge | Badge generation: "false", "true" (both formats), "endpoint", or "svg" | — | false |
| badge-path | Badge base path; the .json/.svg extension is appended | — | openready-badge |
| badge-label | Badge label text | — | openready |
Outputs
| name | description |
|---|---|
| score | Score shown on the badge (single repository, or rounded average); empty when unavailable |
| color | shields.io color for the score |
| gate-passed | "false" when the CI gate failed (CLI exit 4), otherwise "true" |
| report-path | Path of the JSON report |
| badge-endpoint-path | Path of the endpoint JSON badge; empty when not generated |
| badge-svg-path | Path of the SVG badge; empty when not generated |