Plugin: updater-homebrew

Updates a Homebrew formula with the new release URL and checksum. Use it when SemRel publishes tarballs that also need to be reflected in a Homebrew tap.

Installation

Binary

semrel plugin install @semrel/updater-homebrew

semrel plugin install downloads the binary to .semrel/plugins/ and updates .semrel.lock. Commit .semrel.lock to pin the version for your team.

Docker

Pre-built, signed multi-platform images (linux/amd64, linux/arm64) are published on every release:

docker pull ghcr.io/semrels/semrel:latest

Verify the image signature with cosign:

cosign verify ghcr.io/semrels/semrel:latest \
  --certificate-identity-regexp 'https://github.com/SemRels/semrel/.github/workflows/release.yml.*' \
  --certificate-oidc-issuer https://token.actions.githubusercontent.com

Configuration

version: 1
plugins:
  - uses: @semrel/updater-homebrew
    args:
      formula_file: Formula/semrel.rb
      url_template: 'https://github.com/SemRels/semrel/archive/refs/tags/v{{ .NextVersion }}.tar.gz'
      sha256: '${{ env.RELEASE_SHA256 }}'

Environment Variables

Name	Required	Default	Description
`SEMREL_PLUGIN_FORMULA_FILE`	yes	`—`	Homebrew formula file to update.
`SEMREL_PLUGIN_URL_TEMPLATE`	no	`plugin-defined`	Template used to build the download URL for the new release.
`SEMREL_PLUGIN_SHA256`	no	`—`	Checksum to write into the formula.

Release Context Variables

SEMREL_NEXT_VERSION
SEMREL_CURRENT_VERSION
SEMREL_TAG_NAME
SEMREL_DRY_RUN

Behavior

For a 1.4.0 release, the updater can rewrite the formula URL to the v1.4.0 archive and replace the sha256 value with the supplied checksum.

Source

SemRels/updater-homebrew