Publish to Homebrew on release#64
Merged
Merged
Conversation
Add Homebrew distribution alongside PyPI: - New 'homebrew' job in publish.yml opens a formula-bump PR in toddysm/homebrew-regshape after the PyPI publish step - .github/scripts/bump_formula.py resolves the released sdist URL/sha256 from PyPI and rewrites the formula's top-level fields - README + docs/guides/homebrew-install.md document brew install Refs #59, #60, #62, #63
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Pull request overview
Adds Homebrew release automation alongside the existing PyPI release workflow, and updates user-facing installation instructions accordingly.
Changes:
- Update release workflow to also bump the Homebrew tap formula on GitHub Releases.
- Add a Python helper script to rewrite the tap formula’s top-level
url/sha256from PyPI sdist metadata. - Update README installation instructions to include Homebrew.
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
README.md |
Adds Homebrew install instructions alongside existing pip/source install steps. |
docs/guides/homebrew-install.md |
Introduced a Homebrew installation guide document. |
.github/workflows/publish.yml |
Extends the release workflow with a Homebrew tap update job (opens a PR in the tap repo). |
.github/scripts/bump_formula.py |
New script to fetch PyPI sdist URL/SHA and update the Homebrew formula. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Validate formula path in bump_formula.py to prevent path traversal (resolve within CWD + require expected filename) - Add explicit least-privilege 'contents: read' permissions to the publish workflow
Open a fixed 'Formula/regshape.rb' relative to the working directory instead of a caller-supplied path, so no user data flows into a filesystem path. The workflow runs the bumper from the tap checkout via working-directory: tap.
- Rename workflow to reflect it opens a formula-bump PR - Use --force-with-lease instead of --force - Make PR creation idempotent on workflow re-runs - Reuse existing local branch with 'git switch -C'
Owner
Author
|
Review addressed:
All checks green; resolving the (now outdated) threads. |
toddysm
added a commit
that referenced
this pull request
Jul 2, 2026
The file was committed empty in #64; add the intended install/upgrade/ uninstall documentation.
toddysm
added a commit
that referenced
this pull request
Jul 2, 2026
* Restore Homebrew install guide content The file was committed empty in #64; add the intended install/upgrade/ uninstall documentation. * Address review: use 'Guide:' title prefix and fix brew tap hint
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.