Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README: bottle removal docs and remove dome badges #1772

Merged
merged 2 commits into from
Jan 4, 2022
Merged

README: bottle removal docs and remove dome badges #1772

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6c4548e
Remove dome badges
scpeters Dec 31, 2021
48d89a0
Document how to disable bottles
scpeters Dec 31, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 22 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,25 +54,6 @@ To use:
* [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_launch4-install_bottle-homebrew-amd64)](https://build.osrfoundation.org/view/ign-edifice/job/ignition_launch4-install_bottle-homebrew-amd64/) [ignition_launch4](https://build.osrfoundation.org/view/ign-edifice/job/ignition_launch4-install_bottle-homebrew-amd64/)
* [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_edifice-install_bottle-homebrew-amd64)](https://build.osrfoundation.org/view/ign-edifice/job/ignition_edifice-install_bottle-homebrew-amd64/) [ignition_edifice](https://build.osrfoundation.org/view/ign-edifice/job/ignition_edifice-install_bottle-homebrew-amd64/)

### Ignition Dome

* [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_cmake2-install_bottle-homebrew-amd64)](https://build.osrfoundation.org/view/ign-dome/job/ignition_cmake2-install_bottle-homebrew-amd64/) [ignition_cmake2](https://build.osrfoundation.org/view/ign-dome/job/ignition_cmake2-install_bottle-homebrew-amd64/)
* [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_tools1-install_bottle-homebrew-amd64)](https://build.osrfoundation.org/view/ign-dome/job/ignition_tools1-install_bottle-homebrew-amd64/) [ignition_tools1](https://build.osrfoundation.org/view/ign-dome/job/ignition_tools1-install_bottle-homebrew-amd64/)
* [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_math6-install_bottle-homebrew-amd64)](https://build.osrfoundation.org/view/ign-dome/job/ignition_math6-install_bottle-homebrew-amd64/) [ignition_math6](https://build.osrfoundation.org/view/ign-dome/job/ignition_math6-install_bottle-homebrew-amd64/)
* [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_common3-install_bottle-homebrew-amd64)](https://build.osrfoundation.org/view/ign-dome/job/ignition_common3-install_bottle-homebrew-amd64/) [ignition_common3](https://build.osrfoundation.org/view/ign-dome/job/ignition_common3-install_bottle-homebrew-amd64/)
* [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_msgs6-install_bottle-homebrew-amd64)](https://build.osrfoundation.org/view/ign-dome/job/ignition_msgs6-install_bottle-homebrew-amd64/) [ignition_msgs6](https://build.osrfoundation.org/view/ign-dome/job/ignition_msgs6-install_bottle-homebrew-amd64/)
* [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_fuel-tools5-install_bottle-homebrew-amd64)](https://build.osrfoundation.org/view/ign-dome/job/ignition_fuel-tools5-install_bottle-homebrew-amd64/) [ignition_fuel-tools5](https://build.osrfoundation.org/view/ign-dome/job/ignition_fuel-tools5-install_bottle-homebrew-amd64/)
* [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_plugin1-install_bottle-homebrew-amd64)](https://build.osrfoundation.org/view/ign-dome/job/ignition_plugin1-install_bottle-homebrew-amd64/) [ignition_plugin1](https://build.osrfoundation.org/view/ign-dome/job/ignition_plugin1-install_bottle-homebrew-amd64/)
* [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_transport9-install_bottle-homebrew-amd64)](https://build.osrfoundation.org/view/ign-dome/job/ignition_transport9-install_bottle-homebrew-amd64/) [ignition_transport9](https://build.osrfoundation.org/view/ign-dome/job/ignition_transport9-install_bottle-homebrew-amd64/)
* [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=sdformat10-install_bottle-homebrew-amd64)](https://build.osrfoundation.org/job/sdformat10-install_bottle-homebrew-amd64/) [sdformat10](https://build.osrfoundation.org/job/sdformat10-install_bottle-homebrew-amd64/)
* [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_physics3-install_bottle-homebrew-amd64)](https://build.osrfoundation.org/view/ign-dome/job/ignition_physics3-install_bottle-homebrew-amd64/) [ignition_physics3](https://build.osrfoundation.org/view/ign-dome/job/ignition_physics3-install_bottle-homebrew-amd64/)
* [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_rendering4-install_bottle-homebrew-amd64)](https://build.osrfoundation.org/view/ign-dome/job/ignition_rendering4-install_bottle-homebrew-amd64/) [ignition_rendering4](https://build.osrfoundation.org/view/ign-dome/job/ignition_rendering4-install_bottle-homebrew-amd64/)
* [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_gui4-install_bottle-homebrew-amd64)](https://build.osrfoundation.org/view/ign-dome/job/ignition_gui4-install_bottle-homebrew-amd64/) [ignition_gui4](https://build.osrfoundation.org/view/ign-dome/job/ignition_gui4-install_bottle-homebrew-amd64/)
* [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_sensors4-install_bottle-homebrew-amd64)](https://build.osrfoundation.org/view/ign-dome/job/ignition_sensors4-install_bottle-homebrew-amd64/) [ignition_sensors4](https://build.osrfoundation.org/view/ign-dome/job/ignition_sensors4-install_bottle-homebrew-amd64/)
* [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_gazebo4-install_bottle-homebrew-amd64)](https://build.osrfoundation.org/view/ign-dome/job/ignition_gazebo4-install_bottle-homebrew-amd64/) [ignition_gazebo4](https://build.osrfoundation.org/view/ign-dome/job/ignition_gazebo4-install_bottle-homebrew-amd64/)
* [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_launch3-install_bottle-homebrew-amd64)](https://build.osrfoundation.org/view/ign-dome/job/ignition_launch3-install_bottle-homebrew-amd64/) [ignition_launch3](https://build.osrfoundation.org/view/ign-dome/job/ignition_launch3-install_bottle-homebrew-amd64/)
* [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_dome-install_bottle-homebrew-amd64)](https://build.osrfoundation.org/view/ign-dome/job/ignition_dome-install_bottle-homebrew-amd64/) [ignition_dome](https://build.osrfoundation.org/view/ign-dome/job/ignition_dome-install_bottle-homebrew-amd64/)

### Ignition Citadel

* [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_cmake2-install_bottle-homebrew-amd64)](https://build.osrfoundation.org/view/ign-citadel/job/ignition_cmake2-install_bottle-homebrew-amd64/) [ignition_cmake2](https://build.osrfoundation.org/view/ign-citadel/job/ignition_cmake2-install_bottle-homebrew-amd64/)
Expand Down Expand Up @@ -125,6 +106,28 @@ Bottle builds are not triggered automatically for every pull request for several
which will upload bottles directly to GitHub Packages, but the SHA hash associated with these bottles will not be
easily available unless the pull request is merged by a homebrew maintainer.

## To disable broken bottles

When a new major or minor version of a formula is merged to homebrew-core that is a dependency of formulae
in this tap, it may break our bottles, requiring a rebuild (see
[#1728](https://github.com/osrf/homebrew-simulation/issues/1728) or
[#1708](https://github.com/osrf/homebrew-simulation/issues/1709) for example).
As the osrf/simulation bottles will be broken immediately upon the merge in homebrew-core,
it can be useful to disable the broken bottles while waiting for new bottles to be rebuilt.
The `--remove-bottle-block` parameter to `brew bump-revision` can be used in this instance.
For example, the bottle removals from
[8ca61f3d](https://github.com/osrf/homebrew-simulation/commit/8ca61f3dce52e93d3472450e33d9dc2c59523591)
in [#1742](https://github.com/osrf/homebrew-simulation/pull/1742) could be repeated with
the following commands:

~~~
brew bump-revision --remove-bottle-block ignition-msgs1
brew bump-revision --remove-bottle-block ignition-msgs5
brew bump-revision --remove-bottle-block ignition-msgs6
brew bump-revision --remove-bottle-block ignition-msgs7
brew bump-revision --remove-bottle-block ignition-msgs8
~~~

## Troubleshooting

* Does a new bottle need to be built for every homebrew pull request?
Expand Down