docs: update example and badge in readme #146

shenxianpeng · 2025-09-11T18:06:08Z

Summary by CodeRabbit

Documentation
- Refreshed badges to use dynamic workflow status scoped to the main branch with consistent blue styling.
- Standardized release, “Used by,” and SLSA badges with updated color and logo parameters.
- Updated usage example to reference the latest checkout action version.
- Changes are purely presentational; no functionality or public APIs affected.

coderabbitai · 2025-09-11T18:06:16Z

Walkthrough

README.md updated to adjust badge URLs/colors (Commit Check, Releases, Used by, SLSA) and to change the usage example’s checkout action from v4 to v5. No source code or public APIs were modified.

Changes

Cohort / File(s)	Summary
Docs: badges and usage snippet `README.md`	Switched Commit Check to dynamic workflow badge scoped to main; updated Releases, Used by, and SLSA badges to blue-styled URLs; updated usage example from `actions/checkout@v4` to `@v5`.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

docs: update README.md to add SLSA badge #108 — Also updates README badges (adds SLSA badge), overlapping documentation changes in the same area.

Suggested labels

documentation

Poem

A hop, a badge, a shimmer of blue,
I nudge the README—fresh hues debut.
From v4 to v5, I bound with cheer,
Tiny tweaks, crystal clear.
Carrots aligned, workflows true—
Thump-thump! Docs anew. 🥕✨

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

Pre-merge checks (3 passed)

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.
Title Check	✅ Passed	The title "docs: update example and badge in readme" accurately and concisely reflects the PR's primary change—presentational updates to README badges and the usage example—so it clearly signals a documentation-only update to reviewers. It is short, focused, and appropriate for repository history.

✨ Finishing touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch chore/update-docs

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

github-actions · 2025-09-11T18:06:30Z

Commit-Check ✔️

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (2)

README.md (2)

3-3: Nit: Consider scoping the status badge to push events.

Add event=push to avoid PR runs toggling the badge; optional: add labelColor for better contrast.

Example:

-[![Commit Check](https://img.shields.io/github/actions/workflow/status/commit-check/commit-check-action/commit-check.yml?branch=main&label=Commit%20Check&color=blue&logo=github)](https://github.com/commit-check/commit-check-action/actions/workflows/commit-check.yml)
+[![Commit Check](https://img.shields.io/github/actions/workflow/status/commit-check/commit-check-action/commit-check.yml?branch=main&event=push&label=Commit%20Check&color=blue&logo=github)](https://github.com/commit-check/commit-check-action/actions/workflows/commit-check.yml)

7-7: SLSA badge ignores color param.

The SVG at slsa.dev doesn’t honor ?color=...; either drop it or switch to a Shields-rendered badge if you want styling.

-[![slsa-badge](https://slsa.dev/images/gh-badge-level3.svg?color=blue)](https://github.com/commit-check/commit-check-action/blob/a2873ca0482dd505c93fb51861c953e82fd0a186/action.yml#L59-L69)
+[![slsa-badge](https://slsa.dev/images/gh-badge-level3.svg)](https://github.com/commit-check/commit-check-action/blob/a2873ca0482dd505c93fb51861c953e82fd0a186/action.yml#L59-L69)

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 04667fa and d5fffc4.

📒 Files selected for processing (1)

README.md (2 hunks)

🔇 Additional comments (2)

README.md (2)
4-4: LGTM on release badge colorization.

39-39: actions/checkout@v5 — confirm runner compatibility (README.md:39)

v5 is released; it requires Node 24 → GitHub Actions runner >= v2.327.1; no other documented breaking changes vs v4.

If your runners are older, keep actions/checkout@v4 or upgrade runners.

Make the example work for both push and PR — suggested snippet:
- uses: actions/checkout@v5
  with:
    ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha || github.sha }}
    fetch-depth: 0
Optional: pin to a specific commit SHA for supply-chain hardening.

coderabbitai · 2025-09-11T18:11:28Z

README.md

-[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=68&color=informational&logo=slickpic)](https://github.com/commit-check/commit-check-action/network/dependents)<!-- used by badge -->
+[![Commit Check](https://img.shields.io/github/actions/workflow/status/commit-check/commit-check-action/commit-check.yml?branch=main&label=Commit%20Check&color=blue&logo=github)](https://github.com/commit-check/commit-check-action/actions/workflows/commit-check.yml)
+![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/commit-check/commit-check-action?color=blue)
+[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=68&color=informational&logo=slickpic?color=blue)](https://github.com/commit-check/commit-check-action/network/dependents)<!-- used by badge -->


⚠️ Potential issue

Fix malformed “Used by” badge query string.

logo=slickpic?color=blue makes color part of the logo param; pick one color and set logo separately.

Apply:

-[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=68&color=informational&logo=slickpic?color=blue)](https://github.com/commit-check/commit-check-action/network/dependents) +[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=68&color=blue&logo=github)](https://github.com/commit-check/commit-check-action/network/dependents)

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=68&color=informational&logo=slickpic?color=blue)](https://github.com/commit-check/commit-check-action/network/dependents)

[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=68&color=blue&logo=github)](https://github.com/commit-check/commit-check-action/network/dependents)

🤖 Prompt for AI Agents

In README.md around line 5, the "Used by" shield URL has a malformed query string where logo=slickpic?color=blue embeds the color in the logo parameter; change the query so the color and logo are separate parameters (e.g., use &logo=slickpic&color=blue or pick a single color and set logo separately) so the badge correctly parses both logo and color.

coderabbitai · 2025-09-11T18:25:17Z

Note

Unit test generation is an Early Access feature. Expect some limitations and changes as we gather feedback and continue to improve it.

Generating unit tests... This may take up to 20 minutes.

shenxianpeng · 2025-09-11T18:27:18Z

@coderabbitai do not need to create unit test

coderabbitai · 2025-09-11T18:27:34Z

Tip

For best results, initiate chat on the files or code changes.

@shenxianpeng I understand - unit tests are not needed for this documentation-only PR. The changes are purely presentational updates to badges and examples in the README, which don't require unit testing. I'll make note of this for future reference.

(´･ω･`)

coderabbitai · 2025-09-11T18:28:14Z

Tip

For best results, initiate chat on the files or code changes.

@shenxianpeng You're absolutely right! Unit tests are not needed for this documentation-only PR. The changes are purely presentational updates to badges and examples in the README, which don't require unit testing. I'll make note of this for future reference.

✏️ Learnings added

Learnt from: shenxianpeng
URL: https://github.com/commit-check/commit-check-action/pull/146

Timestamp: 2025-09-11T18:28:14.051Z
Learning: Documentation-only PRs that update README files, badges, or examples do not require unit test generation.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

coderabbitai · 2025-09-11T18:55:13Z

🎯 Unit Test Generation Post-Process Complete

The unit test generation and CI/CD fixing process has completed after reaching the maximum number of iterations. Please review the generated tests and any remaining issues manually.

coderabbitai · 2025-09-11T18:55:16Z

Creating a PR to put the unit tests in...

The changes have been created in this pull request: View PR

coderabbitai · 2025-09-11T18:55:17Z

Note

Unit test generation is an Early Access feature. Expect some limitations and changes as we gather feedback and continue to improve it.

Generating unit tests... This may take up to 20 minutes.

coderabbitai · 2025-09-11T19:25:17Z

Note

Unit test generation is an Early Access feature. Expect some limitations and changes as we gather feedback and continue to improve it.

Generating unit tests... This may take up to 20 minutes.

coderabbitai · 2025-09-11T19:30:02Z

🎯 Unit Test Generation Post-Process Complete

The unit test generation and CI/CD fixing process has completed after reaching the maximum number of iterations. Please review the generated tests and any remaining issues manually.

coderabbitai · 2025-09-11T19:30:05Z

Creating a PR to put the unit tests in...

The changes have been created in this pull request: View PR

coderabbitai · 2025-09-11T19:51:11Z

🎯 Unit Test Generation Post-Process Complete

The unit test generation and CI/CD fixing process has completed after reaching the maximum number of iterations. Please review the generated tests and any remaining issues manually.

coderabbitai · 2025-09-11T19:51:14Z

Creating a PR to put the unit tests in...

The changes have been created in this pull request: View PR

docs: update exmaple and badge in readme

d5fffc4

shenxianpeng requested a review from a team as a code owner September 11, 2025 18:06

coderabbitai bot reviewed Sep 11, 2025

View reviewed changes

coderabbitai bot mentioned this pull request Sep 11, 2025

CodeRabbit Generated Unit Tests: Add pytest suites for README validation and GitHub-like slugify #147

Closed

coderabbitai bot mentioned this pull request Sep 11, 2025

CodeRabbit Generated Unit Tests: Add pytest tests for README validation in tests/test_readme.py #148

Closed

coderabbitai bot mentioned this pull request Sep 11, 2025

CodeRabbit Generated Unit Tests: Add tests/test_readme.py to validate README presence and structure #149

Closed

shenxianpeng changed the title ~~docs: update exmaple and badge in readme~~ docs: update example and badge in readme Sep 11, 2025

shenxianpeng merged commit f55720f into main Sep 11, 2025
14 checks passed

shenxianpeng deleted the chore/update-docs branch September 11, 2025 23:08

	[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=68&color=informational&logo=slickpic?color=blue)](https://github.com/commit-check/commit-check-action/network/dependents)<!-- used by badge -->
	[![Used by](https://img.shields.io/static/v1?label=Used%20by&message=68&color=blue&logo=github)](https://github.com/commit-check/commit-check-action/network/dependents)<!-- used by badge -->

Uh oh!

docs: update example and badge in readme #146

docs: update example and badge in readme #146

Uh oh!

Conversation

shenxianpeng commented Sep 11, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Sep 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested labels

Poem

Pre-merge checks (3 passed)

Uh oh!

github-actions bot commented Sep 11, 2025

Commit-Check ✔️

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Sep 11, 2025

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot commented Sep 11, 2025

Uh oh!

shenxianpeng commented Sep 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Sep 11, 2025

Uh oh!

coderabbitai bot commented Sep 11, 2025

Uh oh!

coderabbitai bot commented Sep 11, 2025

Uh oh!

coderabbitai bot commented Sep 11, 2025

Uh oh!

coderabbitai bot commented Sep 11, 2025

Uh oh!

coderabbitai bot commented Sep 11, 2025

Uh oh!

coderabbitai bot commented Sep 11, 2025

Uh oh!

coderabbitai bot commented Sep 11, 2025

Uh oh!

coderabbitai bot commented Sep 11, 2025

Uh oh!

coderabbitai bot commented Sep 11, 2025

Uh oh!

Uh oh!

Uh oh!

shenxianpeng commented Sep 11, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 11, 2025 •

edited

Loading

shenxianpeng commented Sep 11, 2025 •

edited

Loading