[codex] Add scan badges support and update pipeline overview GIF - #285
Conversation
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 18 minutes and 34 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 WalkthroughWalkthroughBadge-generation support was added to the GitHub Action: new inputs/outputs and runtime logic produce Shields-compatible JSON endpoint files from Changes
Sequence Diagram(s)sequenceDiagram
participant Runner as GitHub Actions Runner
participant Action as qtmesh Action (composite)
participant Docker as Docker / qtmesh scan
participant Parser as Badge Generator (jq or text parse)
participant FS as Filesystem (badge dir)
participant Pages as gh-pages publisher
Runner->>Action: start step (inputs incl. generate-badges=true)
Action->>Docker: run `qtmesh scan` (stdout/stderr captured)
Docker-->>Action: stdout + stderr
Action->>Parser: provide captured output
Parser-->>Action: compute metrics & status
Action->>FS: write `*-status/errors/warnings/passed/scanned/skipped`.json
alt badge-base-url provided
Action->>Runner: set badge URL outputs
Runner->>Pages: publish `badge-output-dir` to `gh-pages/badges` (separate step)
end
Action-->>Runner: set `result`, `exit-code`, and badge outputs
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 880ce93f48
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| errors="" | ||
| skipped="" | ||
|
|
||
| if printf '%s\n' "$OUTPUT" | jq -e '.summary | type == "object"' >/dev/null 2>&1; then |
There was a problem hiding this comment.
Handle mixed Docker output when parsing badge metrics
The badge parser assumes OUTPUT is pure JSON by running jq against the entire captured stream, but this action captures docker run with 2>&1, so stderr noise (for example image-pull progress on uncached runners) can prepend non-JSON text. In that case this check fails, the code falls back to the text-summary parser, and with --json output it extracts no counts and emits no-data/zero badges even when scan findings exist. This makes badge outputs incorrect in common first-run CI scenarios.
Useful? React with 👍 / 👎.
|



Summary
action.yml)v1(2.23.0) release descriptionWhat Changed
action.ymlgenerate-badges,badge-output-dir,badge-label-prefix,badge-base-urlstatus,errors,warnings,passed,scanned,skipped)README.mdwebsite/src/DocsApp.jsxwebsite/src/data/content.jsandwebsite/src/App.jsxmedia.pipelineCiCdand used it in the Pipeline Overview section imageValidation
npm --prefix website run buildNotes
generate-badges: trueis provided.Summary by CodeRabbit
New Features
Documentation