Roland Walker
de78b0f359
sleep during uninstall, allow :must_succeed
...
on script directives. followups from #1802 . amend private-eye Cask.
2014-02-08 16:15:15 -05:00
Roland Walker
4802067e30
Merge pull request #2810 from rolandwalker/doc_devscripts
...
Document all developer scripts
2014-02-08 16:11:06 -05:00
Paul Hinze
1f5cc4e1e8
Merge pull request #2719 from lgarron/sha256
...
Change the template hash function to SHA-256.
2014-02-08 12:20:33 -06:00
Roland Walker
124f8d44a3
Document all developer scripts
...
Significantly rewrite "Uninstall Details" in `CONTRIBUTING.md`
2014-02-08 08:03:09 -05:00
Roland Walker
320f8a46d8
Merge pull request #2637 from rolandwalker/version_caveats
...
add os_version_only to caveats DSL
2014-02-06 08:25:40 -05:00
Roland Walker
34f38caf3e
add os_version_only to caveats DSL
2014-02-06 08:25:17 -05:00
Lucas Garron
913f3e6f76
Change default hash to SHA-256.
2014-02-05 18:16:18 -08:00
Roland Walker
bf7b16c0fd
Merge pull request #2554 from rolandwalker/caveats_on_dashboard_widgets
...
Loud caveats against installing Dashboard Widgets
2014-02-04 15:44:53 -08:00
Roland Walker
ba218993a1
Loud caveats against installing Dashboard Widgets
...
And doc note, pending a fix of the underlying issue.
2014-02-03 11:28:44 -05:00
Roland Walker
9445b05c4d
tiny nits on new Screen Saver artifact
...
whitespace, filenames, orthography to be consistent with
other artifacts. No functional change.
2014-02-03 11:21:09 -05:00
Roland Walker
ffe9d025a0
Merge pull request #2681 from rolandwalker/doc_uninstall_sections
...
doc: create specific uninstall sections
2014-01-30 16:25:43 -08:00
Roland Walker
872132f7c8
screensaver spelled screen_saver in DSL and opts
2014-01-29 11:27:44 -05:00
Fernando Paredes
8f177a81ac
Merge pull request #2680 from rolandwalker/doc_xfer_contributing_fonts
...
move font-specific docs to the font repo
2014-01-28 08:58:08 -08:00
Roland Walker
a7bdac580b
doc: create specific uninstall sections
...
move recipes from "Good Things to Know"
2014-01-28 11:32:38 -05:00
Roland Walker
d50f4d5def
move font-specific docs to the font repo
2014-01-28 11:07:51 -05:00
Jonathan Dahan
ca61dfdd81
Add support for screensaver artifact
2014-01-28 10:17:50 -05:00
Paul Hinze
ae2d5822e1
Merge pull request #2592 from rolandwalker/arch_caveats
...
add arch_only to caveats mini-DSL
2014-01-28 06:29:16 -08:00
Paul Hinze
3179a55e71
Merge pull request #2391 from rolandwalker/uninstall_script_order
...
Defer :script uninstall, add :early_script
2014-01-28 06:20:43 -08:00
Roland Walker
a807804e56
doc: Canonical name == App bundle name
...
There's only one substantive change in this patch, which is
that the Canonical App name is defined exactly by the name
of the App bundle on disk. The suggestion that the author's
website be consulted for orthography is removed.
2014-01-28 08:36:12 -05:00
Roland Walker
67e39804e2
Merge pull request #2636 from goxberry/how-to-find-kexts
...
CONTRIBUTING: Add method for finding kexts.
2014-01-28 05:27:19 -08:00
Paul Hinze
a9aabf4f22
Merge pull request #2305 from rolandwalker/depends_on_brew
...
add dependencies for Homebrew formulae
2014-01-26 12:49:38 -08:00
Geoffrey Oxberry
7fa8e2c35c
CONTRIBUTING: Add method for finding kexts.
...
Method based on previous experience finding bundle id(s) and
grepping through packages.
2014-01-25 19:06:46 -08:00
Will Styler
ca19ed6e0a
Add zip subfolder to contributing.md (squash)
...
Now that 'Link Details' exists, it's a great place to discuss how to handle subfolders within zip files. "relative path" is unclear in the world of zip folders, as the root isn't clear either, so an example seemed prudent. Seemed better here than in the link discussion.
Squashed from https://github.com/phinze/homebrew-cask/pull/2617
2014-01-25 14:17:32 -07:00
Roland Walker
a36e4ff1d7
doc followup for link :target
...
Followup for #2532 .
2014-01-25 13:18:53 -05:00
Roland Walker
c59ba39c91
Merge pull request #2532 from voanhduy1512/symlinked
...
Allow customizing the application symlink
2014-01-25 09:03:51 -08:00
Roland Walker
c60711ffed
Merge pull request #2583 from rolandwalker/no_commas_in_link
...
don't use commas in artifact stanzas
2014-01-25 08:59:24 -08:00
Võ Anh Duy
2835172641
Allow customizing the application symlink
2014-01-25 23:43:12 +07:00
Roland Walker
10f2f57a69
don't use commas in artifact stanzas
...
- no functional changes in this patch
- preparation for interface change allowing custom
target links in #2532
2014-01-25 08:43:14 -05:00
Roland Walker
9d2d6e3575
add arch_only to caveats mini-DSL
...
Relevant to points raised by @goxberry in #2581
2014-01-24 10:43:00 -05:00
Roland Walker
926067b140
Merge pull request #2584 from rolandwalker/doc_error_brackets
...
doc error: extraneous brackets
2014-01-24 05:40:48 -08:00
Roland Walker
c7863dbac0
doc error: vagrant uninstall incorrect
2014-01-24 08:40:15 -05:00
Roland Walker
2ff2275bfb
Merge pull request #2526 from goxberry/how-to-find-package-id
...
CONTRIBUTING: Add method for finding package ids.
2014-01-24 03:38:48 -08:00
Geoffrey Oxberry
db8634c6e8
CONTRIBUTING: Add method for finding package ids.
...
Package IDs are contained within <pkg-info> tags within PackageInfo
files. These files can be located by unpackaging a package with
`pkgutil --expand` and then using the `find` command.
2014-01-23 23:04:17 -08:00
Roland Walker
9d439510d3
add dependencies for Homebrew Formulae
...
new DSL key `depends_on_formula`
2014-01-22 16:22:07 -05:00
Roland Walker
9b54342e42
indent to two spaces
...
This patch contains only whitespace changes, plus a short
addition to CONTRIBUTING.md on the project-wide indent style
2014-01-22 13:08:34 -05:00
Roland Walker
fc2241db7a
move squashing doc from HACKING to CONTRIBUTING.md
2014-01-20 17:51:08 -05:00
Roland Walker
406ae7e0bd
Merge pull request #2475 from rolandwalker/doc_commits
...
documentation on commit messages
2014-01-20 14:43:57 -08:00
Roland Walker
329c48298a
caveats first-class in DSL, gets own mini-DSL
...
Make caveats a first-class member of the Cask DSL. It no longer has to
be specified with "def caveats", but can be given as "caveats do ... end"
as with after_install blocks.
In addition, create a mini-DSL which can be used within caveats blocks,
providing standard messages when manual installers must be used,
reboot-required, etc.
Add alternate form: caveats can also accept a compile-time string for
simple cases.
This is 99% compatible with old Casks, as it still works by defining
a caveats method. However, all Casks containing caveats are cleaned
up and adapted according to the new DSL.
Full docs in CONTRIBUTING.md.
2014-01-20 11:54:46 -05:00
Roland Walker
98fc7bfde2
Merge pull request #2416 from linc01n/input-method
...
Implement `input_method` artifact
2014-01-20 08:44:02 -08:00
Roland Walker
4d2e520089
Defer :script uninstall, add :early_script
...
fixes #2254
2014-01-18 18:24:10 -05:00
Roland Walker
175f276de5
documentation on commit messages
...
per request from @fanquake
- expand existing content in CONTRIBUTING.md and break out into section
- add section to HACKING.md
2014-01-18 11:49:34 -05:00
Lincoln Lee
cc14ebdb55
Implement `input_method` artifact
2014-01-19 00:40:56 +08:00
Roland Walker
9c2c589a7c
truly trivial doc followups
...
- sync the docs to match some recent PRs
- formatting mistakes
- capitalization
- quoting
2014-01-18 11:38:34 -05:00
Paul Hinze
bfe3af2f25
Merge pull request #2390 from rolandwalker/hacking_doc
...
Spin out HACKING.md from CONTRIBUTING.md
2014-01-17 16:56:48 -08:00
Roland Walker
6fd0bcbc0c
Spin out HACKING.md from CONTRIBUTING.md
...
Create a bunch of guidelines/FAQs based on stuff gleaned from
PR discussions and IRC. Obviously this is just a starting
point.
2014-01-16 07:02:36 -05:00
Roland Walker
81744a038d
bugfix: make uninstall :script accept a hash
...
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
2014-01-11 12:20:59 -05:00
Stratos Moros
7136269198
implement `binary` artifact
2014-01-05 22:55:18 +02:00
Geoffrey Oxberry
5c92dda304
Distinguish between checking SHA-1 & SHA-256 sums
...
A couple casks use SHA-256 checksums. Add language to describe how to
determine those checksums in an easy way.
2014-01-04 12:11:36 -08:00
Jon Chen
1f77200ebf
use shasum/sha1sum to generate sha-1 hash
2014-01-02 15:36:52 -05:00
Vítor Galvão
2518474085
corrected some namings, according to conventions
2013-12-16 15:26:00 +00:00
Paul Hinze
e46b89c908
Merge pull request #2081 from leoj3n/services-support
...
[WIP] services support
2013-12-15 15:26:44 -06:00
Paul Hinze
f271002540
document URL options
2013-12-15 14:00:43 -06:00
Joel Kuzmarski
7432affc59
services support
2013-12-13 18:13:19 -06:00
Fernando Paredes
20f5f5989d
Fix Contributing layout issue
2013-12-13 14:45:08 -08:00
Paul Hinze
8870f7c1fc
Merge pull request #2008 from kevinSuttle/colorpickers
2013-12-13 10:40:36 -06:00
Kevin Suttle
6dff4a35db
Add support for colorpicker type
2013-12-12 22:59:58 -05:00
Johan
969fca1f83
Fixing Markdown layout error in CONTRIBUTING.md
2013-12-12 12:41:39 +01:00
Paul Hinze
356f82c65d
Merge pull request #2024 from rolandwalker/uninstall_order
...
refine & document order of uninstall keys
2013-12-09 19:27:41 -08:00
Paul Hinze
f288ac5249
Merge pull request #2023 from rolandwalker/doc_more_fields
...
document caveats, after_install, after_uninstall
2013-12-09 19:24:09 -08:00
Roland Walker
07b9eea19b
refine & document order of uninstall 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.
2013-12-09 21:34:30 -05:00
Roland Walker
9ed8407265
document caveats, after_install, after_uninstall
...
in FAQ.md and CONTRIBUTING.md. Also divide fields in CONTRIBUTING.md
into two sections: frequently-used and infrequently-used .
2013-12-09 19:56:25 -05:00
Roland Walker
6d05664532
add :quit key to uninstall
...
The applescript is divided into two commands to keep from transiently
invoking the application in the case where it is not currently running.
2013-12-09 09:23:53 -05:00
Fernando Paredes
d9c77c65cb
Add support for installing Widgets
2013-12-08 09:28:56 -08:00
Fernando Paredes
eb32ed9304
Merge pull request #1991 from rolandwalker/font_doc
...
Document conventions for fonts
2013-12-07 12:19:50 -08:00
Roland Walker
7238439bfc
Document conventions for fonts
...
Multiple faces rule per IRC with @phinze
2013-12-07 15:02:35 -05:00
Roland Walker
e6630fb49e
Fix documentation nits
...
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.
2013-12-07 13:42:16 -05:00
Paul Hinze
5dba177bf1
Merge pull request #1860 from rolandwalker/fonts
...
add support for installing fonts
2013-12-05 18:27:02 -08:00
Fernando Paredes
7221b777a6
Update Contributing guide
...
Add a mention of `rake` command to use tests.
Refs #1893
2013-11-30 16:39:50 -08:00
Roland Walker
5da6e642bf
add support for installing fonts
2013-11-26 08:38:43 -05:00
Fernando Paredes
26de3172a9
Merge pull request #1733 from lgarron/qlplugin
...
QuickLook Plugin Support
2013-11-25 16:00:10 -08:00
phinze
adcffc1da3
clarify contributing symlink instructions
...
closes #1762
2013-11-16 17:29:02 -06:00
Lucas Garron
ee30f839d2
QuickLook plugin support.
2013-11-14 20:26:07 -08:00
Scott Reeves
875ccce975
Document prefpane option
2013-11-10 17:07:37 -05:00
Scott Reeves
3e58afa00c
Add docs for versions repo
2013-11-10 08:39:35 -05:00
Vítor Galvão
b728c24fe9
corrected 1Password's name
2013-11-06 17:47:51 +00:00
phinze
8feec1de14
new preferred sourceforge url style
...
- 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
2013-11-05 22:09:15 -06:00
phinze
5f2146e009
document naming convention in contrib.md
2013-11-03 22:47:26 -06:00
Erwann Mest
0edf0c7a42
Add naming convention (discussion).
2013-10-31 23:33:29 +01:00
phinze
5d10014ba5
work on CONTRIBUTING docs a little
2013-10-19 18:04:24 -05:00
billwanjohi
251c002bdc
contributing.md: symlink to taps instead of home
...
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.
2013-09-14 17:03:51 -05:00
Fernando Paredes
45a5176a11
Update Contributing guide
...
* Update Alfred.app to the latest spec
* Add Vagrant.pkg to illustrate the difference in Casks
* Add `install` and `uninstall` fields to table
2013-07-28 16:08:58 -07:00
Robert Curth
ba52f6377e
[ #583 ] Auditing of cask download and checksums
...
closes #688
2013-07-07 09:06:02 -05:00
James A. Anderson
91a944e607
Update CONTRIBUTING.md with shortened link syntax
2013-05-29 08:31:04 -06:00
Jeff Jewiss
26262f2bf2
Adds .com to example for testing casks
2013-05-13 18:31:27 -04:00
phinze
f144f717e0
revamp contributing docs
...
- 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
2013-05-11 20:18:30 -05:00
pangratz
5b22534368
Update CONTRIBUTING to reflect newer style guides
...
Specify that the SHA-1 checksum shall be used and that the name of the
linked app must be specified via `link`
closes #293
2013-05-11 18:55:51 -05:00
John Schulz
682bbef292
Don't assume `/usr/local`. Use `brew --prefix`
2013-05-11 14:27:29 -07:00
John Schulz
d2ffccc756
Whitespace change. Remove whitespace from empty lines.
2013-05-11 14:15:49 -07:00
Mathias Bynens
733bda49e6
CONTRIBUTING: Update “adding a Cask” instructions
...
Ref. #259 .
2013-05-05 21:01:23 +03:00
phinze
8ed3437bfe
docs on working with the ruby codebase
...
refs #234
2013-04-28 14:27:37 -05:00
phinze
0ef27be8e0
pull in CONTRIBUTING.md from the wiki
...
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!
2013-04-28 12:10:59 -05:00