Skip to content

docs: pin the README action example to a release tag - #97

Merged
2 commits merged into
mainfrom
docs/action-example-pin
Sep 27, 2026
Merged

2 commits merged into
mainfrom
docs/action-example-pin

Conversation

@vitali87

@vitali87 vitali87 commented Aug 30, 2026 •

Copy link
Copy Markdown
Owner

Change

The README's GitHub Action example used vitali87/pr-split@main while the repo's own .github/workflows/split-score.yml pins @v1.0.0. A floating ref means downstream repos silently pick up unreleased action changes; match the shipped workflow.

Verified: v1.0.0 exists on origin, action.yml at the tag is byte-identical to main, and every input/output the README documents is present there. Docs only. Local review: 5/5.

Summary by CodeRabbit

  • Documentation
    • Updated the GitHub Action usage example to reference the stable v1.0.0 release instead of the main branch.

The example used @main while the repo's own split-score.yml pins
@v1.0.0; a floating ref means downstream repos pick up unreleased
action changes. Match the shipped workflow.
@coderabbitai

coderabbitai Bot commented Aug 30, 2026 •

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: f35cf246-e15f-4cff-aa78-02458cafff7d

📥 Commits

Reviewing files that changed from the base of the PR and between 9482d92 and 47a6d1b.

📒 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 GitHub Action example now references vitali87/pr-split@v1.0.0 instead of vitali87/pr-split@main.

Changes

GitHub Action version pin

Layer / File(s) Summary
Update README action reference
README.md
The workflow example now uses the v1.0.0 release tag.

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

Merge Risk: ⚪ Minimal · up to 46e80

This documentation-only change pins the README action example to the repository’s released v1.0.0 tag, preventing downstream users from unintentionally consuming unreleased changes. No actionable merge-blocking risk remains.

🚥 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 documentation change: pinning the README action example to the v1.0.0 release tag.
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.
Full details: Docstring Coverage

Explanation

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 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/action-example-pin

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.

Main already pins the README example to vitali87/pr-split@v1.0.1, so the
PR's @v1.0.0 pin is superseded; this merge leaves no diff against main.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015rnEEjXWDBdePRhKMmZr1w
@greptile-apps

greptile-apps Bot commented Sep 27, 2026

Copy link
Copy Markdown

No reviewable files after applying ignore patterns.

@vitali87 vitali87 closed this pull request by merging all changes into main in 8ca9e3b Sep 27, 2026
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