Skip to content

chore: update docs & and fix homebrew-tap workflow#42

Merged
luxass merged 2 commits into
mainfrom
update-docs
May 25, 2026
Merged

chore: update docs & and fix homebrew-tap workflow#42
luxass merged 2 commits into
mainfrom
update-docs

Conversation

@luxass

@luxass luxass commented May 25, 2026

Copy link
Copy Markdown
Owner

Summary by CodeRabbit

  • Documentation

    • Updated workflow documentation examples to reference v0.8.2 across multiple workflow references.
  • Chores

    • Improved version tag normalization in Homebrew tap workflow for cleaner version string handling.

Review Change Stack

@coderabbitai

coderabbitai Bot commented May 25, 2026

Copy link
Copy Markdown

Caution

Review failed

Pull request was closed or merged during review

Walkthrough

This PR updates documentation examples to reference shared workflow version v0.8.2 and enhances the Homebrew tap workflow to normalize version values by stripping leading 'v' and trailing '@' suffixes before using them in tarball paths, formula metadata, and pull request text.

Changes

Workflow version updates to v0.8.2 and Homebrew tap normalization

Layer / File(s) Summary
Documentation version references updated to v0.8.2
.github/workflows/reusable-ci-security.md, .github/workflows/reusable-ci.md, .github/workflows/reusable-homebrew-tap.md, .github/workflows/reusable-release-npm.md, .github/workflows/reusable-test.md, AGENTS.md, README.md
All workflow documentation examples are updated to reference shared workflow versions v0.8.2 or later. Inline # x-release-please-version comments are removed from some updated lines.
Homebrew tap workflow version normalization and metadata
.github/workflows/reusable-homebrew-tap.yaml
The workflow's display name is changed to lowercase. Version normalization logic strips the leading 'v' prefix and any '@...' suffix from Git tags/refs, applied consistently to checksum computation, formula version field updates, and pull request creation (branch name, commit message, summary text, and PR title).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • luxass/shared-workflows#33: Modifies .github/workflows/reusable-homebrew-tap.yaml's tarball/checksum naming in the release asset handling path with dynamic asset lookup logic.
  • luxass/shared-workflows#28: Modifies the same .github/workflows/reusable-homebrew-tap.yaml update-formula job with checkout and asset download steps.

Poem

🐰 Hoppity bump, the versions rise,
V-zero-eight-point-two—a welcome prize!*
Tabs now parse with grace so fine,
Stripping v's and suffixes in line.
Our workflows dance, prepared and keen,
The cleanest Homebrew I've ever seen! 🍺

🚥 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 accurately reflects the main changes: documentation updates across multiple workflow files and a fix to the homebrew-tap workflow to normalize version values.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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 unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch update-docs

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.

@luxass luxass merged commit 70f18b4 into main May 25, 2026
3 of 4 checks passed
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