Skip to content

CI

CI #31676

Workflow file for this run

name: CI
on:
pull_request:
merge_group:
permissions:
contents: read
env:
HOMEBREW_DEVELOPER: 1
HOMEBREW_NO_AUTO_UPDATE: 1
HOMEBREW_NO_ENV_HINTS: 1
HOMEBREW_BOOTSNAP: 1
HOMEBREW_NO_INSTALL_CLEANUP: 1
HOMEBREW_VERIFY_ATTESTATIONS: 1
defaults:
run:
shell: bash -xeuo pipefail {0}
concurrency:
group: "${{ github.ref }}"
cancel-in-progress: ${{ github.event_name == 'pull_request' }}
jobs:
syntax:
if: github.repository_owner == 'Homebrew'
runs-on: ubuntu-latest
steps:
- name: Set up Homebrew
id: set-up-homebrew
uses: Homebrew/actions/setup-homebrew@master
with:
core: false
cask: false
test-bot: false
- name: Cache Bundler RubyGems
uses: actions/cache@1bd1e32a3bdc45362d1e726936510720a7c30a57 # v4.2.0
with:
path: ${{ steps.set-up-homebrew.outputs.gems-path }}
key: ${{ runner.os }}-rubygems-syntax-${{ steps.set-up-homebrew.outputs.gems-hash }}
restore-keys: ${{ runner.os }}-rubygems-syntax-
- name: Install Bundler RubyGems
run: brew install-bundler-gems --groups=style,typecheck
- name: Install shellcheck and shfmt
run: brew install shellcheck shfmt
- name: Cache style cache
uses: actions/cache@1bd1e32a3bdc45362d1e726936510720a7c30a57 # v4.2.0
with:
path: ~/.cache/Homebrew/style
key: syntax-style-cache-${{ github.sha }}
restore-keys: syntax-style-cache-
- run: brew style
- run: brew typecheck
- name: Check RuboCop filepaths
working-directory: ${{ steps.set-up-homebrew.outputs.repository-path }}/Library/Homebrew
run: |
public_apis="$(git grep -l "@api public" -- :^sorbet/ :^vendor/ | sort)"
rubocop_docs="$(yq '.Style/Documentation.Include[]' .rubocop.yml | sort)"
if [[ "${public_apis}" != "${rubocop_docs}" ]]; then
echo "All public Homebrew APIs should be included in the \`Style/Documentation\` RuboCop."
echo "Add/remove the following paths from \`Library/Homebrew/.rubocop.yml\` as appropriate:"
echo "${public_apis} ${rubocop_docs}" | tr ' ' '\n' | sort | uniq -u
exit 1
fi
tap-syntax:
name: tap syntax
needs: syntax
if: github.repository_owner == 'Homebrew'
runs-on: macos-14
steps:
- name: Set up Homebrew
id: set-up-homebrew
uses: Homebrew/actions/setup-homebrew@master
with:
core: true
cask: true
test-bot: true
- name: Cache Bundler RubyGems
uses: actions/cache@1bd1e32a3bdc45362d1e726936510720a7c30a57 # v4.2.0
with:
path: ${{ steps.set-up-homebrew.outputs.gems-path }}
key: ${{ runner.os }}-rubygems-tap-syntax-${{ steps.set-up-homebrew.outputs.gems-hash }}
restore-keys: ${{ runner.os }}-rubygems-tap-syntax-
- name: Install Bundler RubyGems
run: brew install-bundler-gems --groups=style
- name: Cache style cache
uses: actions/cache@1bd1e32a3bdc45362d1e726936510720a7c30a57 # v4.2.0
with:
path: ~/.cache/Homebrew/style
key: tap-syntax-style-cache-${{ github.sha }}
restore-keys: tap-syntax-style-cache-
- name: Run brew style on homebrew-core
run: brew style homebrew/core
- name: Set up all Homebrew taps
run: |
brew tap homebrew/aliases
brew tap homebrew/bundle
brew tap homebrew/command-not-found
brew tap homebrew/formula-analytics
brew tap homebrew/portable-ruby
brew tap homebrew/services
# brew style doesn't like world writable directories
sudo chmod -R g-w,o-w "$(brew --repo)/Library/Taps"
- name: Run brew style on official taps
run: |
brew style homebrew/bundle \
homebrew/services \
homebrew/test-bot
brew style homebrew/aliases \
homebrew/command-not-found \
homebrew/formula-analytics \
homebrew/portable-ruby
- name: Run brew style on homebrew/cask
run: |
brew style homebrew/cask
formula-audit:
name: formula audit
needs: syntax
if: github.repository_owner == 'Homebrew'
runs-on: ubuntu-latest
container:
image: ghcr.io/homebrew/brew:master
steps:
- name: Set up Homebrew
id: set-up-homebrew
uses: Homebrew/actions/setup-homebrew@master
with:
core: true
cask: false
test-bot: false
- name: Run brew readall on homebrew/core
run: brew readall --os=all --arch=all --aliases homebrew/core
- name: Run brew audit --skip-style on homebrew/core
run: brew audit --skip-style --except=version --tap=homebrew/core
- name: Generate formula API
run: brew generate-formula-api --dry-run
cask-audit:
name: cask audit
needs: syntax
if: github.repository_owner == 'Homebrew'
runs-on: macos-15
steps:
- name: Set up Homebrew
id: set-up-homebrew
uses: Homebrew/actions/setup-homebrew@master
with:
core: true
cask: true
test-bot: false
- name: Run brew readall on all casks
run: brew readall --os=all --arch=all homebrew/cask
- name: Run brew audit --skip-style on homebrew/cask
run: |
brew audit --skip-style --except=version --tap=homebrew/cask
- name: Generate formula API
run: brew generate-formula-api --dry-run
- name: Generate cask API
run: brew generate-cask-api --dry-run
vendored-gems:
name: vendored gems
needs: syntax
runs-on: ubuntu-latest
steps:
- name: Set up Homebrew
id: set-up-homebrew
uses: Homebrew/actions/setup-homebrew@master
with:
core: false
cask: false
test-bot: false
- name: Configure Git user
uses: Homebrew/actions/git-user-config@master
with:
username: BrewTestBot
# Can't cache this because we need to check that it doesn't fail the
# "uncommitted RubyGems" step with a cold cache.
- name: Install Bundler RubyGems
run: brew install-bundler-gems --groups=all
- name: Check for uncommitted RubyGems
working-directory: ${{ steps.set-up-homebrew.outputs.repository-path }}
run: git diff --stat --exit-code Library/Homebrew/vendor/bundle/ruby
update-test:
name: ${{ matrix.name }}
runs-on: ${{ matrix.runs-on }}
needs: syntax
if: github.event_name == 'pull_request' || github.event_name == 'merge_group'
strategy:
matrix:
include:
- name: update-test (Ubuntu)
runs-on: ubuntu-latest
- name: update-test (macOS)
runs-on: macos-15
steps:
- name: Set up Homebrew
id: set-up-homebrew
uses: Homebrew/actions/setup-homebrew@master
with:
core: false
cask: false
test-bot: false
- name: Run brew update-tests
run: |
brew update-test
brew update-test --to-tag
brew update-test --commit=HEAD
tests:
name: ${{ matrix.name }}
needs: syntax
runs-on: ${{ matrix.runs-on }}
strategy:
matrix:
include:
- name: tests (online)
test-flags: --online --coverage
runs-on: ubuntu-latest
- name: tests (generic OS)
test-flags: --generic --coverage
runs-on: ubuntu-latest
- name: tests (Ubuntu 24.04)
test-flags: --coverage
runs-on: ubuntu-24.04
- name: tests (Ubuntu 22.04)
test-flags: --coverage
runs-on: ubuntu-22.04
- name: tests (Ubuntu 20.04)
test-flags: --coverage
runs-on: ubuntu-20.04
- name: tests (macOS 13 x86_64)
test-flags: --coverage
runs-on: macos-13
- name: tests (macOS 15 arm64)
test-flags: --coverage
runs-on: macos-15
steps:
- name: Set up Homebrew
id: set-up-homebrew
uses: Homebrew/actions/setup-homebrew@master
with:
# We only test needs_homebrew_core tests on macOS because
# homebrew/core is not available by default on GitHub-hosted Ubuntu
# runners, and it's expensive to tap it.
core: ${{ runner.os == 'macOS' }}
cask: false
test-bot: false
- name: Cache Bundler RubyGems
uses: actions/cache@1bd1e32a3bdc45362d1e726936510720a7c30a57 # v4.2.0
with:
path: ${{ steps.set-up-homebrew.outputs.gems-path }}
key: ${{ matrix.runs-on }}-tests-rubygems-${{ steps.set-up-homebrew.outputs.gems-hash }}
restore-keys: ${{ matrix.runs-on }}-tests-rubygems-
- run: brew config
- name: Install Bundler RubyGems
run: brew install-bundler-gems --groups=all
- name: Create parallel test log directory
run: mkdir tests
- name: Cache parallel tests log
uses: actions/cache@1bd1e32a3bdc45362d1e726936510720a7c30a57 # v4.2.0
with:
path: tests
key: ${{ runner.os }}-${{ matrix.test-flags }}-parallel_runtime_rspec-${{ github.sha }}
restore-keys: ${{ runner.os }}-${{ matrix.test-flags }}-parallel_runtime_rspec-
- name: Install brew tests dependencies
if: matrix.name != 'tests (generic OS)'
run: brew install buildpulse-test-reporter
- name: Install brew tests --online dependencies
if: matrix.name == 'tests (online)'
run: brew install subversion curl
- name: Install brew tests macOS dependencies
if: runner.os != 'Linux'
run: |
# Workaround GitHub Actions Python issues
brew unlink python && brew link --overwrite python
brew install subversion
# brew tests doesn't like world writable directories
- name: Cleanup permissions
if: runner.os == 'Linux'
run: sudo chmod -R g-w,o-w /home/linuxbrew/.linuxbrew/Homebrew
- name: Run brew tests
if: github.event_name == 'pull_request' || matrix.name != 'tests (online)'
run: |
# brew tests
# Don't attempt to use BuildPulse for generic tests.
# Fails for no apparent reason.
if [[ "${{ matrix.name }}" =~ "generic" ]]
then
unset HOMEBREW_BUILDPULSE_ACCESS_KEY_ID
fi
# Retry multiple times when using BuildPulse to detect and submit
# flakiness (because rspec-retry is disabled).
if [[ -n "${HOMEBREW_BUILDPULSE_ACCESS_KEY_ID-}" ]]
then
brew tests ${{ matrix.test-flags }} ||
brew tests ${{ matrix.test-flags }}
else
brew tests ${{ matrix.test-flags }}
fi
env:
HOMEBREW_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# These cannot be queried at the macOS level on GitHub Actions.
HOMEBREW_LANGUAGES: en-GB
HOMEBREW_BUILDPULSE_ACCESS_KEY_ID: ${{ secrets.BUILDPULSE_ACCESS_KEY_ID }}
HOMEBREW_BUILDPULSE_SECRET_ACCESS_KEY: ${{ secrets.BUILDPULSE_SECRET_ACCESS_KEY }}
HOMEBREW_BUILDPULSE_ACCOUNT_ID: 1503512
HOMEBREW_BUILDPULSE_REPOSITORY_ID: 53238813
- id: junit_xml
working-directory: ${{ steps.set-up-homebrew.outputs.repository-path }}
run: |
mkdir -p test/junit
filenames=$(find test/junit -name 'rspec*.xml' -print | tr '\n' ',')
echo "filenames=${filenames%,}" >> "$GITHUB_OUTPUT"
- uses: codecov/test-results-action@9739113ad922ea0a9abb4b2c0f8bf6a4aa8ef820 # v1.0.1
with:
working-directory: ${{ steps.set-up-homebrew.outputs.repository-path }}
files: ${{ steps.junit_xml.outputs.filenames }}
disable_search: true
token: ${{ secrets.CODECOV_TOKEN }}
- uses: codecov/codecov-action@7f8b4b4bde536c465e797be725718b88c5d95e0e # v5.1.1
with:
working-directory: ${{ steps.set-up-homebrew.outputs.repository-path }}
files: Library/Homebrew/test/coverage/coverage.xml
disable_search: true
token: ${{ secrets.CODECOV_TOKEN }}
test-default-formula:
name: ${{ matrix.name }}
needs: syntax
if: github.repository_owner == 'Homebrew'
runs-on: ${{ matrix.runs-on }}
container: ${{ matrix.container }}
strategy:
matrix:
include:
- name: test default formula (Ubuntu 22.04)
runs-on: ubuntu-latest
container: ghcr.io/homebrew/ubuntu22.04:master
- name: test default formula (Ubuntu 20.04)
runs-on: ubuntu-latest
container: ghcr.io/homebrew/ubuntu20.04
- name: test default formula (macOS 13 x86_64)
runs-on: macos-13
- name: test default formula (macOS 15 arm64)
runs-on: macos-15
env:
HOMEBREW_TEST_BOT_ANALYTICS: 1
HOMEBREW_ENFORCE_SBOM: 1
steps:
- name: Set up Homebrew
id: set-up-homebrew
uses: Homebrew/actions/setup-homebrew@master
with:
core: true
cask: false
test-bot: true
- run: brew test-bot --only-cleanup-before
- run: brew test-bot --only-setup
- run: brew install gnu-tar
- run: brew test-bot --only-formulae --only-json-tab --test-default-formula