Skip to content

docs: point Conventional Branch link at conventionalbranch.org - #287

Merged
shenxianpeng merged 1 commit into
mainfrom
docs/conventional-branch-domain
Sep 16, 2026
Merged

shenxianpeng merged 1 commit into
mainfrom
docs/conventional-branch-domain

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Sep 16, 2026

Copy link
Copy Markdown
Member

What

README.md's branch input description still links Conventional Branch to the project's old GitHub Pages domain. The project moved to conventionalbranch.org.

- - **Description**: check git branch name following [Conventional Branch](https://conventional-branch.github.io/).
+ - **Description**: check git branch name following [Conventional Branch](https://conventionalbranch.org/).

That was the only occurrence of the old domain in the repository — grep -rn "conventional-branch.github.io" . returns nothing after the change. The other "Conventional Branch" mentions (action.yml, main.py comments, main_test.py fixture strings) are plain prose with no URL and are left alone.


Generated by Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated the branch input documentation to link to the new Conventional Branch website.

The project moved off its GitHub Pages domain; conventional-branch.github.io
is the old address. This was its only occurrence in the repository -- the
other Conventional Branch mentions carry no URL.
@shenxianpeng
shenxianpeng requested a review from a team as a code owner September 16, 2026 14:07
@coderabbitai

coderabbitai Bot commented Sep 16, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: ea924f14-9dce-4c36-8c21-b9b6d32ab830

📥 Commits

Reviewing files that changed from the base of the PR and between 6866772 and c5a806d.

📒 Files selected for processing (1)
  • README.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The README changes the Conventional Branch URL in the branch input description.

Changes

Documentation Link Update

Layer / File(s) Summary
Update Conventional Branch link
README.md
The branch input description now links to https://conventionalbranch.org/ instead of the previous URL.

Priority: ⬇️ Low

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

Change: Other

Merge Risk: ⚪ Minimal · up to c5a80

The README link update is low risk and ready to merge.

🚥 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 clearly and concisely describes the README update to use the new Conventional Branch URL.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/conventional-branch-domain

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.

@github-actions

Copy link
Copy Markdown
Contributor

Commit Check

All 5 checks passed

Show all 5 checks
Commit message
  ✔ PR title (docs: point Conventional Branch link at conventionalbranc...)
  ✔ Commit 1/1 (c5a806d) (docs: point Conventional Branch link at conventionalbranc...)
Branch
  ✔ Branch (docs/conventional-branch-domain)
Author
  ✔ Author name (Claude)
  ✔ Author email (noreply@anthropic.com)

commit-check 2.18.0 · Rules reference

@codecov

codecov Bot commented Sep 16, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.11%. Comparing base (6866772) to head (c5a806d).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #287   +/-   ##
=======================================
  Coverage   95.11%   95.11%           
=======================================
  Files           1        1           
  Lines         614      614           
=======================================
  Hits          584      584           
  Misses         30       30           
Flag Coverage Δ
unittests 95.11% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Member Author

commit-check (windows-latest) went red on this PR (run #738). It isn't this change — it's a lost Windows runner:

  • The same check passed on this exact commit. Run #739 is the same workflow (commit-check.yml) on the same head c5a806d, and its commit-check (windows-latest) job concluded success at 14:09:12.
  • The failing job produced no logs. It sat in progress for ~45 minutes (14:08:08 → 14:53:10) and then failed; the log download returns HTTP 404, which is what a runner lost before log upload looks like.
  • Its siblings in the same run passed. ubuntu-latest and macos-latest in run #738 both finished green in about twenty seconds.

The diff is a single README link (conventional-branch.github.ioconventionalbranch.org). There is no mechanism by which that fails on Windows only, in one of two identical runs, without emitting a line of output.

I've re-run the failed job once to clear the red check. If it fails again it's real and I'll dig in rather than call it a flake a second time.


Generated by Claude Code

@shenxianpeng
shenxianpeng merged commit 64db419 into main Sep 16, 2026
24 of 25 checks passed
@shenxianpeng
shenxianpeng deleted the docs/conventional-branch-domain branch September 16, 2026 14:57
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.

2 participants