feat: remove requiring ref in action/checkout

[shenxianpeng]

closes #156

Summary by CodeRabbit

• Documentation

  • Updated workflow usage examples to reflect simplified checkout configuration.

• Chores

  • Streamlined CI/CD workflow by removing explicit branch reference handling, now relying on default checkout behavior.

[coderabbitai]

Walkthrough

This pull request removes explicit branch reference parameters from the actions/checkout step in both the CI workflow configuration and README documentation. The checkout action now uses default behavior instead of pinning to a specific PR head ref, while maintaining fetch-depth: 0.

Changes

Cohort / File(s)	Change Summary
GitHub Actions Workflow .github/workflows/commit-check.yml	Removed ref input parameter from actions/checkout@v5 step; fetch-depth remains set to 0
Documentation README.md	Removed ref input parameter from the actions/checkout@v5 step shown in the Usage example

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Both changes are simple parameter removals with identical intent across two files
• No logic modifications, conditional changes, or behavioral side effects introduced
• Homogeneous edits requiring minimal contextual analysis

Possibly related PRs

• BREAKING CHNAGE: Upgrade commit-check to v2.0.0 #152: Modifies the same actions/checkout ref handling in .github/workflows/commit-check.yml, representing a related but potentially conflicting approach to checkout configuration.

Poem

🐰 A rabbit hops through actions clean,
Removing refs that clutter the scene,
Default paths now lead the way,
Simpler workflows save the day! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Linked Issues check	⚠️ Warning	The PR only removes the ref parameter from checkout but does not address the core issue #156: ensuring the GitHub Action reports validation errors and halts the workflow when validation rules are violated.	Verify that removing the ref parameter actually resolves the validation error reporting in the action, or implement additional changes to address the root cause of validation errors not being surfaced to the user.

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'feat: remove requiring ref in action/checkout' clearly describes the main code change of removing the explicit ref parameter from the checkout action.
Out of Scope Changes check	✅ Passed	All changes (removing ref from actions/checkout in workflow and README example) are directly related to the objective of updating the checkout configuration.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feature/update-readme

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a4daf2b and 60450ef.

📒 Files selected for processing (2)

• .github/workflows/commit-check.yml (0 hunks)
• README.md (0 hunks)

💤 Files with no reviewable changes (2)

• README.md
• .github/workflows/commit-check.yml

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[github-actions]

Commit-Check ✔️