Skip to content

Commit ff4606c

Browse files
committed
feat: add star CTAs to README and job summaries
- 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
1 parent a294f54 commit ff4606c

2 files changed

Lines changed: 14 additions & 2 deletions

File tree

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66
[![GitHub marketplace](https://img.shields.io/badge/Marketplace-commit--check--action-blue)](https://github.com/marketplace/actions/commit-check-action)
77
[![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)
88

9+
<p align="center">
10+
&nbsp;<strong><a href="https://github.com/commit-check/commit-check-action">Star commit-check/commit-check-action</a>&nbsp;— it helps others find us!</strong>
11+
</p>
12+
913
A GitHub Action for checking commit message formatting, branch naming, committer name, email, commit signoff, and more.
1014

1115
## What's New in v2

main.py

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,14 @@
99
# Constants for message titles
1010
SUCCESS_TITLE = "# Commit-Check ✔️"
1111
FAILURE_TITLE = "# Commit-Check ❌"
12+
STAR_CTA = (
13+
"\n---\n"
14+
"<p align=\"center\">\n"
15+
" ⭐ <strong><a href=\"https://github.com/commit-check/commit-check-action\">"
16+
"Star commit-check/commit-check-action</a>"
17+
" &mdash; if this saved you time, help others find it!</strong>\n"
18+
"</p>\n"
19+
)
1220
COMMIT_MESSAGE_DELIMITER = "\x00"
1321
COMMIT_SECTION_SEPARATOR = "\n---\n"
1422

@@ -228,8 +236,8 @@ def read_result_file() -> str | None:
228236
def build_result_body(result_text: str | None) -> str:
229237
"""Create the human-readable result body used in summaries and PR comments."""
230238
if result_text is None:
231-
return SUCCESS_TITLE
232-
return f"{FAILURE_TITLE}\n```\n{result_text}\n```"
239+
return f"{SUCCESS_TITLE}\n{STAR_CTA}"
240+
return f"{FAILURE_TITLE}\n```\n{result_text}\n```\n{STAR_CTA}"
233241

234242

235243
def add_job_summary() -> int:

0 commit comments

Comments
 (0)