Homebrew Actions

To speed up dependency installation, enable bundler-cache: true.

When enabled, the action:

1. Caches vendor/bundle using actions/cache.
2. Configures Bundler to install gems to vendor/bundle.
3. Automatically runs bundle check and bundle install --jobs 4 --retry 3 only if necessary.
4. Uses Gemfile.lock (or Gemfile if lock is missing) for cache hashing.
5. Includes the Ruby version, portable Ruby mode, and Ruby prefix in the cache key to ensure cache integrity.

- name: Set up Ruby with Bundler cache
  uses: Homebrew/actions/setup-ruby@1f8e202ffddf94def7f42f6fa3a482e821489f9c
  with:
    setup-homebrew: true
    bundler-cache: true

The action manages the checkout of homebrew/brew based on the type of repository being tested:

• Non-brew and non-tap repositories: homebrew/brew is checked out at the latest stable tag.
• brew and tap repositories: homebrew/brew stays on the main branch by default. To use a stable tag for these repository types, set stable: true explicitly in the action configuration.

The label-pull-requests action automatically labels pull requests based on defined criteria. It evaluates the files changed in the PR, the content of those files, and the PR body. Crucially, it will also remove labels from a pull request that no longer satisfy the defined criteria.

You can provide the labeling definitions (def) using either a JSON array or a YAML list. Both formats require a token (typically a GitHub API token) to perform the labeling operations.

- name: Label PR
  uses: Homebrew/actions/label-pull-requests@1f8e202ffddf94def7f42f6fa3a482e821489f9c
  with:
    token: ${{secrets.HOMEBREW_GITHUB_API_TOKEN}}
    def: |
      - label: example-label
        path: Formula/.+

The setup-ruby action installs and configures Ruby using Homebrew. It is compatible with ubuntu and macos runners (the latter requires Homebrew to be present).

By default, the action installs the Homebrew ruby formula and adds it to the PATH. You can also choose to use Homebrew's portable Ruby, which is the same Ruby that Homebrew itself uses (brew ruby).

- name: Set up Ruby
  uses: Homebrew/actions/setup-ruby@1f8e202ffddf94def7f42f6fa3a482e821489f9c

The api-commit-and-push action commits and pushes changes to a repository using the GitHub API instead of the standard git CLI. This is specifically useful for GitHub Apps that must use the API to ensure commits are properly signed.

To use this action, you must first obtain a token (e.g., via actions/create-github-app-token) and then provide that token, a commit message, and a target branch to the action.

- uses: actions/create-github-app-token@v3
  id: app-token
  with:
    app-id: ${{ vars.APP_ID }}
    private-key: ${{ secrets.PRIVATE_KEY }}

- run: git add some/file.txt

- uses: Homebrew/actions/api-commit-and-push@1f8e202ffddf94def7f42f6fa3a482e821489f9c # 2026.07.10.1
  with:
    message: Update generated files
    branch: some-branch
    token: ${{ steps.app-token.outputs.token }}

The limit-pull-requests action restricts the number of open pull requests a specific user can have in a repository.

Prerequisites

• Tools: The runner must have GitHub CLI (gh) and jq installed.
• Workflow Trigger: This action must be used in a pull_request_target workflow to ensure it has the necessary permissions to interact with pull requests.
• Permissions: The workflow requires the following GitHub permissions:
  • contents: read
  • pull-requests: write

The git-user-config action globally configures the Git identity (user name and email) for a specified GitHub user within a workflow run. This is useful for ensuring that commits or automated actions are attributed to a specific user rather than the default runner identity.

By default, if no username is provided, the action uses the value of the $GITHUB_ACTOR environment variable.

- name: Configure git
  uses: Homebrew/actions/git-user-config@1f8e202ffddf94def7f42f6a3a482e821489f9c # 2026.07.10.1
  with:
    # Defaults to $GITHUB_ACTOR if not specified
    username: BrewTestBot