Skip to content

feat: add Homebrew tap and Chocolatey distribution - #1

Merged
iamEtornam merged 4 commits into
mainfrom
feat/add-to-package-managers
Apr 5, 2026
Merged

iamEtornam merged 4 commits into
mainfrom
feat/add-to-package-managers

Conversation

@iamEtornam

Copy link
Copy Markdown
Owner

Adds Homebrew and Chocolatey distribution workflows. See HOMEBREW.md and CHOCOLATEY.md for details.

- Add Homebrew formula automation that updates iamEtornam/homebrew-tap
  on every published GitHub release (homebrew-tap.yml)
- Add Chocolatey CLI executable package automation that embeds ports.exe
  directly and relies on Shimgen for PATH shim (chocolatey.yml)
- Add render-homebrew-formula.sh and render-chocolatey-package.sh scripts
- Add HOMEBREW.md and CHOCOLATEY.md maintainer guides
- Update README and QUICKSTART to list Homebrew as recommended install path
  on macOS/Linux, Chocolatey as recommended path on Windows
- Fix placeholder yourusername/your-username repo URLs across Cargo.toml,
  install.sh, CHANGELOG.md, and QUICKSTART.md
- Align Apple Silicon release asset name to ports-macos-arm64 everywhere

Made-with: Cursor

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request implements release automation for Homebrew and Chocolatey, adding maintainer documentation and scripts to generate the necessary package manifests. It also updates the project's metadata and installation guides to reflect the new distribution channels and correct repository URLs. The review feedback highlights opportunities to improve documentation clarity by using placeholders in examples and identifies a discrepancy between the README and the actual logic in the installation script.

Comment thread CHOCOLATEY.md Resolved
Comment thread HOMEBREW.md Resolved
Comment thread HOMEBREW.md Resolved
Comment thread README.md Resolved
- CHOCOLATEY.md: derive $version from $tag in local test example
- HOMEBREW.md: replace hardcoded v0.2.1 with <tag> placeholder in examples
- README.md: remove inaccurate install.sh Homebrew fallback bullet

Made-with: Cursor
@iamEtornam iamEtornam self-assigned this Apr 5, 2026
@iamEtornam

Copy link
Copy Markdown
Owner Author

/gemini review

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces Homebrew and Chocolatey distribution support for the port-viewer tool, including new maintainer documentation, automation scripts for rendering package metadata, and updated installation guides. It also updates repository URLs and author information across the codebase. Review feedback recommends re-categorizing changelog entries to align with standard conventions, improving the portability of manual checksum commands for macOS users, and using versioned URLs in the Chocolatey package specification for better link stability.

Comment thread CHANGELOG.md Resolved
Comment thread HOMEBREW.md Resolved
Comment thread scripts/render-chocolatey-package.sh Resolved
- CHANGELOG.md: split distribution entries into Added vs Changed
  per Keep a Changelog conventions
- HOMEBREW.md: use shasum -a 256 instead of sha256sum (macOS compatible)
- render-chocolatey-package.sh: use versioned tag URLs for licenseUrl
  and docsUrl instead of main branch links

Made-with: Cursor
@iamEtornam

Copy link
Copy Markdown
Owner Author

/gemini review

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces release automation and maintainer documentation for Homebrew and Chocolatey. It includes new scripts for rendering Homebrew formulas and Chocolatey packages, updates the project's installation guides (README, QUICKSTART, and CHANGELOG), and corrects repository URLs throughout the codebase. The review feedback suggests improving the robustness of the Chocolatey rendering script by handling version tag prefixes and using script-relative paths for file operations.

Comment thread scripts/render-chocolatey-package.sh Resolved
Comment thread scripts/render-chocolatey-package.sh Resolved
- render-chocolatey-package.sh: accept version with or without leading v,
  strip it internally so Chocolatey gets a clean version number
- render-chocolatey-package.sh: resolve LICENSE path relative to script
  location so the script works from any working directory
- render-chocolatey-package.sh: use tag variable (with v prefix) for
  GitHub release URL in releaseNotes
- chocolatey.yml: pass full TAG_NAME to render script; let script strip v

Made-with: Cursor
@iamEtornam
iamEtornam merged commit c6356df into main Apr 5, 2026
11 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