Update brew list command to remove deprecation warning #4995

miketheman · 2020-10-24T17:59:39Z

Homebrew has begun emitting a deprecation warning when checking for
requirements on osx as of Homebrew/brew#8851

Example output when installing a Ruby:

rvm install 2.7.2
Searching for binary rubies, this might take some time.
No binary rubies available for: osx/10.15/x86_64/ruby-2.7.2.
Continuing with compilation. Please read 'rvm help mount' to get more information on binary rubies.
Checking requirements for osx.
Warning: Calling `brew list` to only list formulae is deprecated! Use `brew list --formula` instead.
... (repeated ~12 times on my system)
Warning: Calling `brew list` to only list formulae is deprecated! Use `brew list --formula` instead.
Certificates bundle '/usr/local/etc/[email protected]/cert.pem' is already up to date.
Requirements installation successful.
...

This does not impact the execution, and the command completes
successfully, however it's extra noise for the end user.

The --formula flag was added back in August in Homebrew/brew#8229
and brew will auto-update in most scenarios - but users who have set the
environment variable to not auto-update brew may fail this command with:

Error: ambiguous option: --formula

I do not have any insight when brew may handle the deprecation warning
and remove the existing behavior.

Fixes #5007

Homebrew has begun emitting a deprecation warning when checking for requirements on osx as of Homebrew/brew#8851 Example output when installing a Ruby: ``` rvm install 2.7.2 Searching for binary rubies, this might take some time. No binary rubies available for: osx/10.15/x86_64/ruby-2.7.2. Continuing with compilation. Please read 'rvm help mount' to get more information on binary rubies. Checking requirements for osx. Warning: Calling `brew list` to only list formulae is deprecated! Use `brew list --formula` instead. ... (repeated ~12 times on my system) Warning: Calling `brew list` to only list formulae is deprecated! Use `brew list --formula` instead. Certificates bundle '/usr/local/etc/[email protected]/cert.pem' is already up to date. Requirements installation successful. ... ``` This does not impact the execution, and the command completes successfully, however it's extra noise for the end user. The `--formula` flag was added back in August in Homebrew/brew#8229 and brew will auto-update in most scenarios - but users who have set the environment variable to not auto-update brew may fail this command with: Error: ambiguous option: --formula I do not have any insight when brew may handle the deprecation warning and remove the existing behavior. Signed-off-by: Mike Fiedler <[email protected]>

Signed-off-by: Mike Fiedler <[email protected]>

miketheman · 2020-10-24T18:03:07Z

I've added an entry to the CHANGELOG.md - but am uncertain how to interpret the other messages from the Mergable bot - so would appreciate any pointers you may have.

havenwood · 2020-10-29T16:06:24Z

I've added an entry to the CHANGELOG.md - but am uncertain how to interpret the other messages from the Mergable bot - so would appreciate any pointers you may have.

I added a Label and Milestone for Mergeable.

Any idea how old the --formula flag is? Will this be backward compatible to still work with very old versions of Homebrew? If so, LGTM.

Thanks for the PR!

miketheman · 2020-10-29T16:54:18Z

Any idea how old the --formula flag is? Will this be backward compatible to still work with very old versions of Homebrew?

Thanks - I called that out in the PR description:

The --formula flag was added back in August in Homebrew/brew#8229 ...

felixbuenemann · 2020-11-05T14:35:01Z

The brew commit that added the deprecation warning is Homebrew/brew@c8809ce.

I don't think it makes sense, to document something as the default behavior and then throw a deprecation warning if you actually do depend on that default, which I've mentioned to @Akylzhan in a comment to the commit.

Added to that this breaks backwards compatibility, which makes the change even worse.

cmd/list.rb: --formula, --cask as default TTY: cmd/list.rb: proper deprecated message on non TTY outputs update manpage update zsh completion updated manpages/brew.1 update tests return list_casks list_spec.rb: not output to stderr

pkuczynski · 2020-11-10T18:43:15Z

I've added an entry to the CHANGELOG.md - but am uncertain how to interpret the other messages from the Mergable bot - so would appreciate any pointers you may have.

Mergeable fixed

pkuczynski · 2020-11-10T18:45:12Z

Any idea how old the --formula flag is? Will this be backward compatible to still work with very old versions of Homebrew?

Thanks - I called that out in the PR description:

The --formula flag was added back in August in Homebrew/brew#8229 ...

Maybe we should check brew --version and only add the flag for older homebrew versions? Can you add this please?

In the event the user has a version of homebrew older than 2.5.7, when the `--formula` flag was introduced, allow the command to continue. Signed-off-by: Mike Fiedler <[email protected]>

…com/miketheman/rvm into miketheman/update-brew-list-command

miketheman · 2020-11-11T23:30:47Z

Maybe we should check brew --version and only add the flag for older homebrew versions? Can you add this please?

I took a look at this, and added a detection mechanism. I'm not certain of the idioms used in the codebase, but this seemed to match similar cases of version comparison.

miketheman · 2020-11-11T23:32:08Z

scripts/functions/requirements/osx_brew

  \typeset brew_lib_prefix
-  brew list -1 | __rvm_grep "^${1}$" >/dev/null &&
+  # Test for older versions of Homebrew before adding the `--formula` flag.
+  brew_version=$( brew --version | tee | head -n 1 | sed 's/[^0-9.]*\([0-9.]*\).*/\1/' )


tee was necessary to prevent a broken pipe, since the brew command will return one line before proceeding to check other versions of casks. If there's a preferred way of doing this, happy to adapt.

I know the PR is merged, but if you can use AWK it gets cleaner:

brew --version | awk 'NR==1 { print $2 }'

Do you wanna fire up PR with this change?

Sure thing! I wasn't sure if it was a change worth enough to open a PR, but I'll make one now :)

Does not hurt for sure :) Thanks!

pkuczynski

LGTM!

miketheman added 2 commits October 24, 2020 13:39

Update CHANGELOG.md

367844b

Signed-off-by: Mike Fiedler <[email protected]>

havenwood added this to the rvm-1.29.11 milestone Oct 29, 2020

havenwood added the fixed label Oct 29, 2020

Merge branch 'master' into miketheman/update-brew-list-command

d840a65

havenwood requested a review from pkuczynski October 29, 2020 17:14

Merge branch 'master' into miketheman/update-brew-list-command

c3126b5

miketheman added 2 commits November 11, 2020 18:29

fix: add brew version detection

a39075a

In the event the user has a version of homebrew older than 2.5.7, when the `--formula` flag was introduced, allow the command to continue. Signed-off-by: Mike Fiedler <[email protected]>

Merge branch 'miketheman/update-brew-list-command' of https://github.…

66ae5d0

…com/miketheman/rvm into miketheman/update-brew-list-command

miketheman commented Nov 11, 2020

View reviewed changes

havenwood mentioned this pull request Nov 24, 2020

Warning: Calling brew list to only list formulae is deprecated! Use brew list --formula instead. #5007

Closed

Merge branch 'master' into miketheman/update-brew-list-command

0ad235e

pkuczynski previously approved these changes Nov 24, 2020

View reviewed changes

Update CHANGELOG.md

6e6a120

pkuczynski dismissed their stale review via 6e6a120 November 24, 2020 20:21

pkuczynski changed the title ~~Update brew list command~~ Update brew list command to remove deprecation warning Nov 24, 2020

pkuczynski merged commit b64f1c2 into rvm:master Nov 24, 2020

miketheman deleted the miketheman/update-brew-list-command branch November 24, 2020 20:53

This was referenced Dec 25, 2020

OSX requirement brew issue #4998

Closed

Use brew list --formula instead #5017

Closed

DNA mentioned this pull request Dec 27, 2020

Use AWK to check Brew version #5022

Merged

Uh oh!

Update brew list command to remove deprecation warning #4995

Update brew list command to remove deprecation warning #4995

Uh oh!

Conversation

miketheman commented Oct 24, 2020 • edited by pkuczynski Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

miketheman commented Oct 24, 2020

Uh oh!

havenwood commented Oct 29, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

miketheman commented Oct 29, 2020

Uh oh!

felixbuenemann commented Nov 5, 2020

Uh oh!

pkuczynski commented Nov 10, 2020

Uh oh!

pkuczynski commented Nov 10, 2020

Uh oh!

miketheman commented Nov 11, 2020

Uh oh!

miketheman Nov 11, 2020

Choose a reason for hiding this comment

Uh oh!

DNA Dec 24, 2020

Choose a reason for hiding this comment

Uh oh!

pkuczynski Dec 25, 2020

Choose a reason for hiding this comment

Uh oh!

DNA Dec 27, 2020

Choose a reason for hiding this comment

Uh oh!

pkuczynski Dec 28, 2020

Choose a reason for hiding this comment

Uh oh!

pkuczynski left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

miketheman commented Oct 24, 2020 •

edited by pkuczynski

Loading

havenwood commented Oct 29, 2020 •

edited

Loading