gcloud-cli cask automatically edits shell rc file

[ellisonmarks]

Verification

• I understand that if I ignore these instructions, my issue may be closed without review.
• I have retried my command with --force.
• I ran brew update-reset && brew update and retried my command.
• I ran brew doctor, fixed as many issues as possible and retried my command.
• I have checked the instructions for reporting bugs.
• I made doubly sure this is not a checksum does not match / SHA256 mismatch error (do not open an issue before trying to open a PR to fix first).

Description of issue

After 2cc77ab, the gcloud-cli cask edits the default shell rc file to source files which add a separate PATH entry and shell completions. This was somewhat surprising, as normally formulas, and even brew itself, output such changes as suggestions to the user after installation.

Additionally, it removes some binaries (docker-credential-gcloud, git-credential-gcloud) from the homebrew bin directory, while leaving others.

Taken together, on one hand, this causes duplicate entries in the path, and on the other, any tool that previously got by with only homebrew's bin directory now needs to be altered to account for this new path.

@maythazin5 as the author of that commit.

Command that failed

brew update --cask gcloud-cli

Output of command with --verbose --debug

N/A

Output of brew doctor and brew config

N/A

Output of brew tap

N/A

[maythazin5]

We've made an update to the installation process to improve usability.

Previously, Homebrew users had to manually configure their PATH to use all of gcloud's binary components. The gcloud homebrew installation only made a few default components, like bq and gsutil, available directly. This meant that if you installed additional components, you wouldn't be able to run them without an extra, manual step. gcloud has 20+ binary components and adding them in ${HOMEBREW_PREFIX}/bin path is not feasible since they can be installed via users demand only.

Now, the installation script automatically adds the gcloud root bin path to your shell's source file. This means that all gcloud components—both the default ones and any others you install later—will be accessible from your command line right after you install them. We also tidied up the installation by no longer adding docker-credential-gcloud and git-credential-gcloud to ${HOMEBREW_PREFIX}/bin by default since they weren't necessary for most users.

Please let us know if it's causing any issue for adding the gcloud root bin path to the shell source file. Thanks.

[ellisonmarks]

I see what you're saying about the binaries for components. However, modifying the shell rc file without user interaction is a little questionable to me. Not everyone puts path manipulations in the same file, and if the user removes the changes from the rc file, they'll be put back there if the cask is installed again. The pattern in homebrew for this situation seems to be to use a caveat to explain to the user what changes they might make. https://docs.brew.sh/Formula-Cookbook#caveats