Skip to content

Add CI status badge to README - #3

Merged
mcaney006 merged 1 commit into
mainfrom
readme-ci-badge
Nov 18, 2026
Merged

mcaney006 merged 1 commit into
mainfrom
readme-ci-badge

Conversation

@mcaney006

@mcaney006 mcaney006 commented Nov 18, 2026 •

Copy link
Copy Markdown
Owner

Shows the status of the CI workflow (zig build test on Linux and macOS) for the main branch at the top of the README. The badge links to the workflow's run history.


Note

Low Risk
Documentation-only README change with no impact on build, runtime, or security behavior.

Overview
Adds a CI status badge at the top of README.md that shows GitHub Actions results for the main branch and links to the workflow run history for .github/workflows/ci.yml.

Reviewed by Cursor Bugbot for commit f6a7600. Configure here.

@ecc-tools

ecc-tools Bot commented Nov 18, 2026

Copy link
Copy Markdown

ECC Tools / Security Evidence

Commit: f6a76007825672b5fca3dddd2465b6355bd0ea79

Security evidence gate passed (success)

No security-sensitive scanner-evidence gap detected.

Mode: enforce

Scanned 1 changed file(s). No missing scanner-evidence signal was detected.

Check publication was denied or unavailable. An app owner must enable Checks: read and write, and the installation owner must approve the updated permission.

@ecc-tools

ecc-tools Bot commented Nov 18, 2026

Copy link
Copy Markdown

ECC Tools / PR Risk Taxonomy

Commit: f6a76007825672b5fca3dddd2465b6355bd0ea79

PR taxonomy clear (success)

Scanned 1 changed file(s). No taxonomy bucket signals were detected.

Scanned 1 changed file(s).

No PR taxonomy bucket signals were detected.

Check publication was denied or unavailable. An app owner must enable Checks: read and write, and the installation owner must approve the updated permission.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 18, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-18T22:03:52.437256Z f6a7600 PR opened
ℹ️ 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@ecc-tools

ecc-tools Bot commented Nov 18, 2026

Copy link
Copy Markdown

ECC Tools / Reference Set Readiness

Commit: f6a76007825672b5fca3dddd2465b6355bd0ea79

Reference set readiness gaps detected (neutral)

Reference evidence present for 0/7 areas (0%) across 1 changed file(s).

This check is based on files changed in this PR. Repository-level readiness is still reported by /ecc-tools analyze comments and generated manifests.

Area Status Evidence / Next Step
Deep analyzer corpus Missing Add analyzer fixture, golden, benchmark, or reference-set files that can catch analyzer regressions.
RAG/evaluator comparison Missing Add retrieval or evaluator reference-set comparison fixtures with expected ranking behavior.
PR salvage/review corpus Missing Add stale-PR, review-thread, reopen-flow, or salvage reference cases for queue cleanup automation.
Discussion triage corpus Missing Add public discussion triage fixtures, golden cases, or reference sets for informational, answered, and no-response classifications.
Harness compatibility Missing Add cross-harness, adapter-compliance, or harness-audit evidence for Claude, Codex, OpenCode, Zed, dmux, and agent surfaces.
Security evidence Missing Attach security evidence such as SBOMs, SARIF, audit reports, or AgentShield evidence packs.
CI failure-mode evidence Missing Add captured CI failure logs, dry-run fixtures, or troubleshooting docs for common workflow failure modes.

Check publication was denied or unavailable. An app owner must enable Checks: read and write, and the installation owner must approve the updated permission.

@coderabbitai

coderabbitai Bot commented Nov 18, 2026 •

Copy link
Copy Markdown

Explain Change →

Caution

Review failed

The pull request is closed.

Summary

Purpose
The README gives no visible build status. A reader cannot check whether the main branch builds and passes tests without opening the CI system. This change adds a status badge that shows the CI state at the top of the README.

Material changes

  • README.md: adds one Markdown image link after the # Zigmap heading. The image points to the ci.yml workflow badge for the main branch. The link target is the same workflow page.
  • Diff size: 1 file, +2/-0.
  • No source, build, configuration, dependency, or workflow files changed in this diff.

Execution flow
No runtime control flow changes. The badge image is fetched by the viewer of the README from GitHub when the page renders. The badge reflects the latest run of ci.yml on main.

Risk assessment

Category Rating Explanation
Correctness Low The change adds Markdown only. The badge URL uses the repository mcaney006/ZigMap and workflow file ci.yml. The diff does not show that this workflow file exists.
Memory safety and undefined behavior Not applicable No code changed.
Concurrency and synchronization Not applicable No code changed.
Security and credential handling Low No credentials or tokens are added. The badge loads a public image from GitHub.
Performance and resource usage Low One extra image request when the README renders.
Reliability and recovery Low The badge has no effect on builds. If the workflow file is renamed or removed, the badge shows an unknown state.
Backward compatibility Low No interfaces or public declarations changed.
Deployment and rollback Low Revert the two added lines to roll back.

Validation

  • Present: the diff output from git diff against merge base 0a4df6a, showing the two added lines in README.md.
  • Not available: rendering of the README, verification that .github/workflows/ci.yml exists on main, and the current badge state. The shell result did not show the workflow file.
  • No tests, static analysis, sanitizers, or compiler checks apply to this change.

Operational impact

  • Configuration changes: none.
  • Environment variables, IAM requirements, filesystem changes, schema changes, hardware assumptions, and migration steps: none.
  • Network requirement: the README viewer must reach GitHub to load the badge image.
  • Rollback: remove the added badge line from README.md.

Engineering note
The badge is a small, clean addition. Its only dependency is the workflow filename ci.yml. If that name is wrong, the badge stays broken and fails silently. Confirm the workflow file name before merge.

The README now displays a GitHub Actions CI status badge linked to the workflow.

Changes: README CI badge

Layer / File(s) Summary
Add workflow status badge
README.md
The README adds a CI status badge linked to the GitHub Actions workflow.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Other

Possibly related PRs

Merge Risk: Minimal · up to f6a76

This documentation-only change adds a CI status badge to the README and has no runtime impact. It is ready to merge.

- [ ] Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

Share

A badge blinks on the README’s steel face.
The workflow hums behind the glass.
Green and red pass through the wires.
The machine reports without a word.
The status light keeps its watch.

@ecc-tools

ecc-tools Bot commented Nov 18, 2026

Copy link
Copy Markdown

ECC Tools / Hosted Promotion Readiness

Commit: f6a76007825672b5fca3dddd2465b6355bd0ea79

Hosted promotion readiness passed (success)

No hosted promotion evidence gaps detected across 1 changed file(s); 0 corpus scenarios had matching evidence.

This check compares PR file changes against the evaluator/RAG promotion corpus in src/analyzers/fixtures/evaluator-rag-corpus.ts.
Hosted output scoring inspected 0 completed cached hosted job results.

No evaluator corpus scenarios matched this PR.

Check publication was denied or unavailable. An app owner must enable Checks: read and write, and the installation owner must approve the updated permission.

@qodo-code-review

Copy link
Copy Markdown

ⓘ Qodo reviews are paused because your trial has ended. Ask your workspace admin to add credits to resume reviews. Manage billing

@gitar-bot

gitar-bot Bot commented Nov 18, 2026

Copy link
Copy Markdown

Important

You are using the Gitar free plan. Upgrade to unlock code review, CI analysis, auto-apply, custom automations, and more.

Gitar

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Devin Review

@mcaney006
mcaney006 merged commit a295da6 into main Nov 18, 2026
6 of 9 checks passed
@mcaney006
mcaney006 deleted the readme-ci-badge branch November 18, 2026 22:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant