This document describes how to update the macOS Homebrew Formula for a new SUMO release.
All relevant files can be found in the repository at https://github.com/DLR-TS/homebrew-sumo.
brew requires the
homebrew- prefix in order for the
brew tap dlr-ts/sumo command to work.
Step-by-Step Formula Update Guide#
After a new SUMO release (see HowToRelease), follow these steps (assuming you have already checked out the repository):
Run the bash script:
./update_formula.sh <NEW_VERSION> <SUMO_SRC_URL>
<NEW_VERSION>is the version string of the new sumo release (e.g.,
<SUMO_SRC_URL>is the URL to the respective source code archive with examples (e.g.,
This script automates (including local git commits):
- Archiving the old formula (for the previous sumo version)
- Creating a new temporary
sumogit branch (same name as the formula)
- Bumping the formula version (via
- Removing the (now obsolete) bottle block in the formula
- Updating the symlink in
- Updating the version number in
Push the local commits to upstream:
git push --set-upstream origin sumo
Create a pull request from the new branch to trigger the
tests.ymlworkflow which performs a formula audit, install test, and bottle creation.
If the previous workflow ran successfully, label the PR with the
pr-pulltag. This triggers the
publish.ymlworkflow which uploads the bottles to GitHub and deletes the temporary sumo branch afterwards.