Skip to content

docs: scope README Release badge to push events#191

Merged
steipete merged 2 commits into
openclaw:mainfrom
zozo123:fix/release-badge-event-push
May 31, 2026
Merged

docs: scope README Release badge to push events#191
steipete merged 2 commits into
openclaw:mainfrom
zozo123:fix/release-badge-event-push

Conversation

@zozo123

@zozo123 zozo123 commented May 31, 2026

Copy link
Copy Markdown
Contributor

Summary

The README Release badge rendered red ("release - failing") even though the release flow works. The badge SVG URL had no event filter, so GitHub resolved it against the most-recent workflow run — a cancelled workflow_dispatch run on main — instead of the successful tag-push release runs. The CI badge on the line above is already scoped with ?branch=main.

This scopes the Release badge to ?event=push so it reflects tag-push release status. Only the badge SVG URL changes; the link target and the release workflow are untouched.

Verification

$ rg -n "actions/workflows/release.yml/badge.svg" README.md
6:[![Release](https://github.com/openclaw/crabbox/actions/workflows/release.yml/badge.svg?event=push)](https://github.com/openclaw/crabbox/actions/workflows/release.yml)

# before (unscoped) — what main renders today
$ curl -L -s 'https://github.com/openclaw/crabbox/actions/workflows/release.yml/badge.svg' \
    | sed -n 's/.*<title>\([^<]*\)<\/title>.*/\1/p'
release - failing

# after (?event=push) — the URL this PR uses
$ curl -L -s 'https://github.com/openclaw/crabbox/actions/workflows/release.yml/badge.svg?event=push' \
    | sed -n 's/.*<title>\([^<]*\)<\/title>.*/\1/p'
release - passing

$ go build -trimpath -o bin/crabbox ./cmd/crabbox   # OK
$ git diff --check                                   # clean

Closes #189

🤖 Generated with Claude Code

@zozo123 @claude
docs: scope README Release badge to push events
7227477 
The badge SVG URL lacked an event filter, so GitHub resolved it against
the most-recent workflow run — a cancelled workflow_dispatch on main —
and rendered "release - failing". Adding ?event=push scopes it to
tag-push release runs, which are passing.

Fixes openclaw#189.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@clawsweeper

clawsweeper Bot commented May 31, 2026 •
edited
Loading

Copy link
Copy Markdown

Codex review: needs maintainer review before merge. Reviewed May 31, 2026, 5:30 AM ET / 09:30 UTC.

Summary
This PR scopes the README Release workflow badge image URL to push events and adds an unreleased changelog note crediting the fix.

Reproducibility: not applicable. for a docs PR, but the behavior being fixed is well demonstrated by the PR body's before/after badge URL output.

Review metrics: none identified.

Merge readiness
Overall: 🐚 platinum hermit
Proof: 🦞 diamond lobster
Patch quality: 🐚 platinum hermit
Result: ready for maintainer review.

Overall follows the weaker of proof and patch quality, so missing proof can cap an otherwise strong patch.

Rank-up moves:

  • none.

Next step before merge

  • [P2] No repair lane is needed; the remaining action is ordinary maintainer review and merge/check handling.

Security
Cleared: The diff only changes README badge text and changelog prose; it does not alter workflows, dependencies, permissions, secrets, or executable code.

Review details

Best possible solution:

Merge the focused README badge fix with the maintainer-owned release note once normal checks and maintainer review are satisfied.

Do we have a high-confidence way to reproduce the issue?

Not applicable for a docs PR, but the behavior being fixed is well demonstrated by the PR body's before/after badge URL output.

Is this the best way to solve the issue?

Yes. Adding ?event=push to the badge image URL is the narrowest maintainable fix because it changes only how GitHub selects badge runs and leaves the release workflow untouched.

AGENTS.md: found and applied where relevant.

Codex review notes: model gpt-5.5, reasoning high; reviewed against 9a42efcdaefc.

Label changes

Label changes:

  • add rating: 🐚 platinum hermit: Overall readiness is 🐚 platinum hermit; proof is 🦞 diamond lobster and patch quality is 🐚 platinum hermit.
  • remove rating: 🦐 gold shrimp: Current PR rating is rating: 🐚 platinum hermit, so this older rating label is no longer current.

Label justifications:

  • P3: The PR is a low-risk documentation badge correction with no runtime behavior change.
  • rating: 🐚 platinum hermit: Overall readiness is 🐚 platinum hermit; proof is 🦞 diamond lobster and patch quality is 🐚 platinum hermit.
  • status: 👀 ready for maintainer look: ClawSweeper has no concrete contributor-facing blocker left for this PR. Sufficient (terminal): The PR body includes copied terminal output for the exact badge URLs showing the after-fix badge title changes to passing.
  • proof: sufficient: Contributor real behavior proof is sufficient. The PR body includes copied terminal output for the exact badge URLs showing the after-fix badge title changes to passing.
Evidence reviewed

What I checked:

  • Current main behavior: Current main still has the unscoped Release badge image URL in README.md, so the central change is not implemented on the default branch. (README.md:6, 9a42efcdaefc)
  • PR diff: The PR changes the README badge image URL to badge.svg?event=push and leaves the workflow link target unchanged; it also adds a changelog entry. (README.md:6, f5f1c01b4bf4)
  • Real behavior proof: The PR body includes terminal output showing the unscoped badge title as release - failing and the new ?event=push badge title as release - passing. (f5f1c01b4bf4)
  • README provenance: The current README badge block traces to the 0.23.0 release commit, which introduced the unscoped Release badge currently on main. (README.md:6, e35b7a78d5bb)
  • Changelog provenance: The current unreleased changelog section was started by the latest main commit, making the PR's changelog hunk adjacent to recent release-note ownership. (CHANGELOG.md:3, 9a42efcdaefc)
  • Repository policy: AGENTS.md was read fully; the PR uses full GitHub issue URLs and includes verification consistent with the repository PR guidance. (AGENTS.md:1)

Likely related people:

  • Peter Steinberger: Git blame and file history show this person introduced the current README badge block in the 0.23.0 release commit and recently started the unreleased changelog section touched by the PR. (role: recent area contributor; confidence: high; commits: e35b7a78d5bb, 9a42efcdaefc; files: README.md, CHANGELOG.md)
What the crustacean ranks mean
  • 🦀 challenger crab: rare, exceptional readiness with strong proof, clean implementation, and convincing validation.
  • 🦞 diamond lobster: very strong readiness with only minor maintainer review expected.
  • 🐚 platinum hermit: good normal PR, likely mergeable with ordinary maintainer review.
  • 🦐 gold shrimp: useful signal, but proof or patch confidence is still limited.
  • 🦪 silver shellfish: thin signal; proof, validation, or implementation needs work.
  • 🧂 unranked krab: not merge-ready because proof is missing/unusable or there are serious correctness or safety concerns.
  • 🌊 off-meta tidepool: rating does not apply to this item.

Shiny media proof means a screenshot, video, or linked artifact directly shows the changed behavior. Runtime, network, CSP, and security claims still need visible diagnostics.

How this review workflow works
  • ClawSweeper keeps one durable marker-backed review comment per issue or PR.
  • Re-runs edit this comment so the latest verdict, findings, and automation markers stay together instead of adding duplicate bot comments.
  • A fresh review can be triggered by eligible @clawsweeper re-review comments, exact-item GitHub events, scheduled/background review runs, or manual workflow dispatch.
  • PR/issue authors and users with repository write access can comment @clawsweeper re-review or @clawsweeper re-run on an open PR or issue to request a fresh review only.
  • Maintainers can also comment @clawsweeper review to request a fresh review only.
  • Fresh-review commands do not start repair, autofix, rebase, CI repair, or automerge.
  • Maintainer-only repair and merge flows require explicit commands such as @clawsweeper autofix, @clawsweeper automerge, @clawsweeper fix ci, or @clawsweeper address review.
  • Maintainers can comment @clawsweeper explain to ask for more context, or @clawsweeper stop to stop active automation.

@clawsweeper clawsweeper Bot added proof: sufficient Contributor real behavior proof is sufficient. rating: 🦐 gold shrimp Decent PR readiness signal, but merge confidence is limited. status: 👀 ready for maintainer look ClawSweeper has no concrete contributor-facing blocker left for this PR. P3 Low-risk cleanup, docs, polish, ergonomics, or speculative feature. labels May 31, 2026
@clawsweeper clawsweeper Bot added rating: 🐚 platinum hermit Good normal PR readiness with ordinary maintainer review expected. and removed rating: 🦐 gold shrimp Decent PR readiness signal, but merge confidence is limited. labels May 31, 2026
@steipete steipete merged commit 7547675 into openclaw:main May 31, 2026
5 checks passed
@zozo123 zozo123 mentioned this pull request May 31, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

P3 Low-risk cleanup, docs, polish, ergonomics, or speculative feature. proof: sufficient Contributor real behavior proof is sufficient. rating: 🐚 platinum hermit Good normal PR readiness with ordinary maintainer review expected. status: 👀 ready for maintainer look ClawSweeper has no concrete contributor-facing blocker left for this PR.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

The README's badge of release is red, even though the release flow works.

2 participants

@zozo123 @steipete