The indentation in CONTRIBUTING.md implies that :script accepts a hash.
But that is not the case. Instead :script accesses the entire hash defined
by uninstall. Unrelated install keys such as :quit leak through to
@command.run! when attempting to exec :script. Result: contrary to docs,
:script cannot be combined with other uninstall keys.
This PR makes uninstall :script accept a hash. When :args or :input are not
needed, :script can still accept a plain string, so many Casks require no
alteration.
In addition
- adds key :executable, required when using hash argument to :script
- keys to :script are validated and sanitized before being passed to
@command.run!
- adds :quit to with-installable.rb test to protect against regression
on leaky keys
Proposed order - :script, :launchctl, :quit, :kext, :pkgutil, :files. Quit
a process before attempting to unload an assocated kext, unload kext before
attempting to delete the associated file, etc. Arguably :script fits
loically with :files near the end of the list. However, we also have
:after_uninstall which implicitly fires immediately after :files.
Therefore, running :script early provides greater functionality.
Mostly this is spelling, capitalization, and whitespace. One
substantive change is updating the list of fields given in FAQ.md
to match CONTRIBUTING.md. Also incorporates suggestions from @NanoXD,
removing an old paragraph from FAQ.md re: nested containers.
- document sf link policy
- change audit to accept old and new style links
- need to keep old style links for projects where the 'latest' link
does not point to something usable
- link to official policy in audit warning message
refs #1436
The rest of the contribution instructions
have people working on the clone already in brew taps.
This just updates a reference that is still pointing
to the would-be contributors' home directory.
- recommend working out of the main tap rather than symlinking, as it
seems to make the instructions shorter/simpler
- add user's fork as a remote of the main tap, and push branch to that
- reference the new brew cask create command
refs #306
this will cause it to show up as a link from incoming pull requests, and
also make the documentation and its change history a little more
first-class with respect to the rest of the project.
big ups to @mkouhia, @passcod, @mwarkentin, and @vincecima for their
work on this document!
Roland Walker