Update CONTRIBUTING.md

[adidalal]

First pass at #16373

Comments welcome. cc @caskroom/maintainers

[adidalal]

could use a better "placeholder name" here

[vitorgalvao]

No issues with the name, but the quotes took me a second. Something like <cask-to-update> {{cask-to-update}} might be clearer. If you’re unhappy with the name, how about outdated-cask?

[adidalal]

Using cask-repair covers #16464 - not sure where else to mention appcast updates, as the rest is really about new casks.

[vitorgalvao]

Since you’re using $github_user on the command, why not follow the same pattern for the cask? I.e.:

outdated_cask=<the-cask-i-want-to-update>
cd "$(brew --repository)/Library/Taps/caskroom/homebrew-cask"
cask-repair --pull origin --push $github_user $outdated-cask

[adidalal]

Done and squashed

[vitorgalvao]

Just renamed the repo to vitorgalvao/tiny-scripts (I wanted that name from the start, but at the time homebrew didn’t allow hyphens in tap names). The old name still works (looks like github is handling the redirection well), but still the new name should be used.

[adidalal]

Just "updated" my tap. All seems to be good.

[~] > brew untap vitorgalvao/tinyscripts
[~] > brew tap vitorgalvao/homebrew-tiny-scripts
[~] > brew uninstall cask-repair prfixmaster fastmerge
Uninstalling /usr/local/Cellar/cask-repair/0.13.3... (4 files, 11.5K)
Uninstalling /usr/local/Cellar/prfixmaster/0.4... (4 files, 7.4K)
Uninstalling /usr/local/Cellar/fastmerge/0.7.1... (4 files, 7.2K)
[~] > brew install cask-repair prfixmaster fastmerge
==> Installing cask-repair from vitorgalvao/tiny-scripts
==> Cloning https://github.com/vitorgalvao/tiny-scripts.git
{snip)

The Formulas repo needs a README update, but otherwise okay

[vitorgalvao]

The Formulas repo needs a README update

Nice catch. Thank you.

No need to reinstall, though, I’ve tried it, and homebrew seemed to still identify them correctly.

[adidalal]

CONTRIBUTING updated. If it looks good, we can merge this

[adidalal]

@zmwangx Here's the updated documentation with cask-repair mentioned. Let me know if things seem clear enough here

[zmwangx]

👍 LGTM, except one minor thing: cask-repair can't necessarily handle all casks (correct me if I'm wrong; I'm thinking about casks with funny download URLs that not only depends on version — there used to be such casks if memory serves), so maybe a disclaimer should be added.

[vitorgalvao]

@zmwangx cask-repair does handle all casks (I started working on it before we started doing version interpolation). In the case where a cask has a non-interpolated URL, you’ll still type the version, but you’ll need the new URL in your clipboard (it automatically detects those cases and adjusts the message).

[adidalal]

@vitorgalvao I added a (slight) disclaimer - though cask-repair works almost all the time.

Let me know if the wording is too strong, either way.

[zmwangx]

Cool 👍 Just to make sure, are there any half interpolated URLs, e.g., https://example.com/2016/01/07/foo-#{version}.dmg, which would trick cask-repair to think of it as an always up-to-date URL? I think I've seen something like that, but it might be my illusion, or might be in a PR.

[vitorgalvao]

I added a (slight) disclaimer - though cask-repair works almost all the time.

I’m fine with that. But any case cask-repair doesn’t work on I consider a bug (and fix when it is reported).

Also (and to also reply to)

Just to make sure, are there any half interpolated URLs, e.g., https://example.com/2016/01'07/foo-#{version}.dmg, which would trick cask-repair to think of it as a always up-to-date URL? I think I've seen so something like that, but it might be my illusion, or might be in a PR.

Lets not forget cask-repair does allow you to make manual fixes, and even rechecks and audits those for you.

So yes, @zmwangx, cask-repair will be tricked by those, but a half-interpolated URL isn’t useful anyway (i.e. it’s a fault of the cask, not cask-repair), and should be fixed in the cask itself (and you can do so within cask-repair).

[zmwangx]

should be fixed in the cask itself

Yes.