Skip to content

feat: add star CTAs to README and job summaries#209

Open
shenxianpeng wants to merge 2 commits into
mainfrom
feature/growth-star-cta
Open

feat: add star CTAs to README and job summaries#209
shenxianpeng wants to merge 2 commits into
mainfrom
feature/growth-star-cta

Conversation

@shenxianpeng
Copy link
Copy Markdown
Member

@shenxianpeng shenxianpeng commented May 26, 2026

Summary

P1 growth flywheel: convert 125+ Used-by users into GitHub stargazers.

Changes

  1. README.md — prominent ⭐ star CTA centered below the badge bar, above the fold
  2. main.pySTAR_CTA constant appended to every job summary and PR comment (both success and failure cases)

Screenshots

README (top of page):

⭐ Star commit-check/commit-check-action — it helps others find us!

Job Summary footer (appears on every CI run):

---
⭐ Star commit-check/commit-check-action — if this saved you time, help others find it!

Why

Every one of the 125+ repos running this Action in CI now sees a star prompt on every run. Combined with the README CTA, this is the highest-leverage growth move available.

Summary by CodeRabbit

  • New Features
    • Added a star call-to-action banner to the README.
    • Added a star call-to-action to build results output for success and failure states.

Review Change Stack

- Add prominent 'Star this repo' call-to-action at the top of README
- Inject star/brand CTA into every job summary and PR comment footer
- Target: convert 125+ Used-by users into stargazers
@shenxianpeng shenxianpeng requested a review from a team as a code owner May 26, 2026 05:35
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 26, 2026

📝 Walkthrough

Walkthrough

This PR adds a star call-to-action across the repository. A new STAR_CTA markdown constant is defined in main.py and appended to both success and failure job output bodies via build_result_body(). The README is updated with a centered call-to-action block encouraging users to star the repository.

Changes

Star CTA Integration

Layer / File(s) Summary
CTA constant definition and output integration
main.py, README.md
Introduces STAR_CTA constant with star call-to-action markup and integrates it into build_result_body() output for success and failure cases. README is updated with a centered banner encouraging repository stars.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested labels

documentation

Poem

⭐ A tiny spark to guide the way,
Star us bright, the devs all say!
A CTA whisper, soft and keen,
The best promotion you have seen!
Rabbit hops and cheers hooray,
More stars brightening every day!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'feat: add star CTAs to README and job summaries' accurately describes the main changes: adding call-to-action elements to both the README file and the job summary output in main.py.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/growth-star-cta

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
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 26, 2026

Commit-Check ❌

Commit rejected by Commit-Check.                                  
                                                                  
  (c).-.(c)    (c).-.(c)    (c).-.(c)    (c).-.(c)    (c).-.(c)  
   / ._. \      / ._. \      / ._. \      / ._. \      / ._. \   
 __\( C )/__  __\( H )/__  __\( E )/__  __\( C )/__  __\( K )/__ 
(_.-/'-'\-._)(_.-/'-'\-._)(_.-/'-'\-._)(_.-/'-'\-._)(_.-/'-'\-._)
   || E ||      || R ||      || R ||      || O ||      || R ||   
 _.' '-' '._  _.' '-' '._  _.' '-' '._  _.' '-' '._  _.' '-' '._ 
(.-./`-´\.-.)(.-./`-´\.-.)(.-./`-´\.-.)(.-./`-´\.-.)(.-./`-´\.-.)
 `-´     `-´  `-´     `-´  `-´     `-´  `-´     `-´  `-´     `-´ 
                                                                  
Commit rejected.                                                  
                                                                  
Type subject_imperative check failed ==> chore: auto fixes from pre-commit.com hooks 
Commit message should use imperative mood (e.g., 'fix bug' not 'fixed bug', 'add feature' not 'adding feature')
Suggest: Change the first verb to imperative form, e.g., 'fix' instead of 'fixed'/'fixes'/'fixing'

Star commit-check/commit-check-action — if this saved you time, help others find it!

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@main.py`:
- Around line 239-240: Tests that assert the exact output of build_result_body
need to be updated because SUCCESS_TITLE and FAILURE_TITLE outputs now have
STAR_CTA appended; change expectations to include STAR_CTA (e.g., expect
build_result_body(None) to equal SUCCESS_TITLE plus "\n" plus STAR_CTA) and for
failures expect FAILURE_TITLE + "\n```\n" + result_text + "\n```\n" + STAR_CTA;
update any test helpers or fixtures that compare raw SUCCESS_TITLE or
FAILURE_TITLE to instead compare the full string returned by build_result_body
so assertions match the new contract.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5b60e3f8-7250-4b13-bf56-ef5365b1df21

📥 Commits

Reviewing files that changed from the base of the PR and between a294f54 and a946455.

📒 Files selected for processing (2)
  • README.md
  • main.py

Comment thread main.py
Comment on lines +239 to +240
return f"{SUCCESS_TITLE}\n{STAR_CTA}"
return f"{FAILURE_TITLE}\n```\n{result_text}\n```\n{STAR_CTA}"
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Update output-contract tests for build_result_body after CTA append.

This changes the result-body contract; tests asserting exact success output (build_result_body(None) == SUCCESS_TITLE) will now fail and should be updated to include/assert STAR_CTA in both success and failure paths.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@main.py` around lines 239 - 240, Tests that assert the exact output of
build_result_body need to be updated because SUCCESS_TITLE and FAILURE_TITLE
outputs now have STAR_CTA appended; change expectations to include STAR_CTA
(e.g., expect build_result_body(None) to equal SUCCESS_TITLE plus "\n" plus
STAR_CTA) and for failures expect FAILURE_TITLE + "\n```\n" + result_text +
"\n```\n" + STAR_CTA; update any test helpers or fixtures that compare raw
SUCCESS_TITLE or FAILURE_TITLE to instead compare the full string returned by
build_result_body so assertions match the new contract.

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