Skip to content

Latest commit

 

History

History
523 lines (357 loc) · 23.2 KB

CONTRIBUTING.md

File metadata and controls

523 lines (357 loc) · 23.2 KB
Raw

How To Contribute

So you want to contribute to the project. THIS IS GREAT NEWS! Seriously. We're all pretty happy about this. Here’s how to get started:

Getting Set Up To Contribute

  1. Fork the repository in GitHub with the Fork button.

  2. Add your GitHub fork as a remote for your homebrew-cask Tap:

$ github_user='<my-github-username>'
$ cd "$(brew --repository)"/Library/Taps/caskroom/homebrew-cask
$ git remote add "$github_user" "https://github.com/$github_user/homebrew-cask"

Adding a Cask

Making a Cask is easy: a Cask is a small Ruby file.

Examples

Here’s a Cask for shuttle as an example.

cask 'shuttle' do
  version '1.2.5'
  sha256 '7df182f506b80011222c0cdd470be76e0376f38e331f3fafbb6af9add3578023'

  url "https://github.com/fitztrev/shuttle/releases/download/v#{version}/Shuttle.zip"
  appcast 'https://github.com/fitztrev/shuttle/releases.atom',
          :sha256 => '9f66dbb98f73f69f4a1759d4bdb8d2552060d599548427740e239ca45185fe5c'
  name 'Shuttle'
  homepage 'https://fitztrev.github.io/shuttle/'
  license :mit

  app 'Shuttle.app'

  zap :delete => '~/.shuttle.json'
end

Here is another Cask for genymotion. Note that you may repeat the app stanza as many times as you need, to define multiple apps:

cask 'genymotion' do
  version '2.6.0'
  sha256 '9d12ae904761d76b15a556262d7eb32d1f5031fe60690224d7b0a70303cf8d39'

  url "http://files2.genymotion.com/genymotion/genymotion-#{version}/genymotion-#{version}.dmg"
  name 'Genymotion'
  homepage 'https://www.genymotion.com/'
  license :commercial

  depends_on :cask => 'virtualbox'

  app 'Genymotion.app'
  app 'Genymotion Shell.app'
  binary 'Genymotion Shell.app/Contents/MacOS/genyshell'

  caveats do
    files_in_usr_local
  end
end

And here is one for gateblu. Note that it has an unversioned download (the download url does not contain the version number, unlike the example above). It also suppresses the checksum with sha256 :no_check (necessary since the checksum will change when a new distribution is made available). This combination of version :latest and sha256 :no_check is currently the preferred mechanism when a versioned download URL is not available. Also note the comment above url, which is needed when the url and homepage hostnames differ:

cask 'gateblu' do
  version :latest
  sha256 :no_check

  # amazonaws.com is the official download host per the vendor homepage
  url 'https://s3-us-west-2.amazonaws.com/gateblu/gateblu-ui/latest/Gateblu.dmg'
  name 'Gateblu'
  homepage 'https://gateblu.octoblu.com'
  license :mit

  pkg 'Gateblu Installer.pkg'

  uninstall :pkgutil => 'com.octoblu.*',
            :delete => '/Applications/Gateblu.app'
end

version methods

In the examples above, when possible the url stanza uses #{version} (string interpolation) to create a Cask that only needs version and sha256 changes when updated. This can be taken further, when needed, with ruby String methods. For example:

Instead of

version '1.2.3'
url 'http://example.com/file-version-123.dmg'

We can

version '1.2.3'
url "http://example.com/file-version-#{version.delete('.')}.dmg"

We can also leverage the power of regular expressions. So instead of

version '1.2.3build4'
url 'http://example.com/1.2.3/file-version-1.2.3build4.dmg'

We can

version '1.2.3build4'
url "http://example.com/#{version.sub(%r{build\d+}, '')}/file-version-#{version}.dmg"

That can become hard to read, however. Since many of these changes are common, we provide a number of helpers to clearly interpret otherwise obtuse cases:

Method Input Output
major 1.2.3-a45,ccdd88 1
minor 1.2.3-a45,ccdd88 2
patch 1.2.3-a45,ccdd88 3
major_minor 1.2.3-a45,ccdd88 1.2
major_minor_patch 1.2.3-a45,ccdd88 1.2.3
before_comma 1.2.3-a45,ccdd88 1.2.3-a45
after_comma 1.2.3-a45,ccdd88 ccdd88
dots_to_hyphens 1.2.3-a45,ccdd88 1-2-3-a45,ccdd88
no_dots 1.2.3-a45,ccdd88 123-a45,ccdd88

Similar to dots_to_hyphens, we provide all logical permutations of {dots,hyphens,underscores,slashes}_to_{dots,hyphens,underscores,slashes}. The same applies to no_dots in the form of no_{dots,hyphens,underscores,slashes}, with an extra no_dividers that applies all of those at once.

Finally, there are before_colon and after_colon that act like their comma counterparts. These four are extra special to allow for otherwise complex cases, and should be used sparingly. There should be no more than one of , and : per version. Use , first, and : only if absolutely necessary.

Generating a Token for the Cask

The Cask token is the mnemonic string people will use to interact with the Cask via brew cask install, brew cask search, etc. The name of the Cask file is simply the token with the extension .rb appended.

The easiest way to generate a token for a Cask is to run this command:

$ "$(brew --repository)/Library/Taps/caskroom/homebrew-cask/developer/bin/generate_cask_token" '/full/path/to/new/software.app'

If the software you wish to Cask is not installed, or does not have an associated App bundle, just give the full proper name of the software instead of a pathname:

$ "$(brew --repository)/Library/Taps/caskroom/homebrew-cask/developer/bin/generate_cask_token" 'Google Chrome'

If the generate_cask_token script does not work for you, see Cask Token Details.

The brew cask create Command

Once you know the token, create your Cask with the handy-dandy brew cask create command.

$ brew cask create my-new-cask

This will open $EDITOR with a template for your new Cask, to be stored in the file my-new-cask.rb. Running the create command above will get you a template that looks like this:

cask 'my-new-cask' do
  version ''
  sha256 ''

  url ''
  name ''
  homepage ''
  license :unknown # todo: change license and remove this comment; ':unknown' is a machine-generated placeholder

  app ''
end

Cask Stanzas

Fill in the following stanzas for your Cask:

name value
version application version; give the value :latest if only an unversioned download is available
sha256 SHA-256 checksum of the file downloaded from url, calculated by the command shasum -a 256 <file>. Can be suppressed by using the special value :no_check. (see also Checksum Stanza Details)
url URL to the .dmg/.zip/.tgz file that contains the application. A comment should be added if the hostnames in the url and homepage stanzas differ (see also URL Stanza Details)
name the full and proper name defined by the vendor, and any useful alternate names (see also Name Stanza Details)
homepage application homepage; used for the brew cask home command
license a symbol identifying the license for the application. Valid category licenses include :oss, :closed, and :unknown. It is OK to leave as :unknown. (see also License Stanza Details)
app relative path to an .app bundle that should be linked into the ~/Applications folder on installation (see also App Stanza Details)

Other commonly-used stanzas are:

name value
pkg relative path to a .pkg file containing the distribution (see also Pkg Stanza Details)
uninstall procedures to uninstall a Cask. Optional unless the pkg stanza is used. (see also Uninstall Stanza Details)

Additional stanzas you might need for special use-cases:

name value
prefpane relative path to a preference pane that should be linked into the ~/Library/PreferencePanes folder on installation
colorpicker relative path to a ColorPicker plugin that should be linked into the ~/Library/ColorPickers folder on installation
qlplugin relative path to a QuickLook plugin that should be linked into the ~/Library/QuickLook folder on installation
font relative path to a font that should be linked into the ~/Library/Fonts folder on installation
service relative path to a service that should be linked into the ~/Library/Services folder on installation
binary relative path to a binary that should be linked into the /usr/local/bin folder on installation
input_method relative path to a input method that should be linked into the ~/Library/Input Methods folder on installation
screen_saver relative path to a Screen Saver that should be linked into the ~/Library/Screen Savers folder on installation
suite relative path to a containing directory that should be linked into the ~/Applications folder on installation
container :nested => relative path to an inner container that must be extracted before moving on with the installation; this allows us to support dmg inside tar, zip inside dmg, etc.
caveats a string or Ruby block providing the user with Cask-specific information at install time (see also Caveats Stanza Details)

Even more special-use stanzas are listed at Optional Stanzas and Legacy Stanzas.

Stanza order

Having a common order for stanzas makes Casks easier to update and parse. Below is the the complete stanza sequence (no Cask will have all stanzas). The empty lines shown here are also important, as they help to visually delineate information.

version
sha256

url
appcast,
  :sha256 # shown here as it is required with `appcast`
name
homepage
license
gpg, :key_id # on same line, since first part is typically small

auto_updates
accessibility_access
conflicts_with
depends_on
container

suite
app
pkg
installer
binary
colorpicker
font
input_method
internet_plugin
prefpane
qlplugin
screen_saver
service
audio_unit_plugin
vst_plugin
artifact, :target # :target shown here as is required with `artifact`
stage_only

preflight

postflight

uninstall_preflight

uninstall_postflight

uninstall

zap

caveats

Note that every stanza that has additional parameters (:symbols after a ,) shall have them on separate lines, one per line, in alphabetical order. Exceptions are gpg and :target (when not applied to url) which typically consist of short lines.

SourceForge/OSDN URLs

SourceForge and OSDN (formerly SourceForge.JP) projects are common ways to distribute binaries, but they provide many different styles of URLs to get to the goods.

We prefer URLs of this format:

http://downloads.sourceforge.net/sourceforge/$PROJECTNAME/$FILENAME.$EXT

Or, if it’s from OSDN:

http://$STRING.osdn.jp/$PROJECTNAME/$RELEASEID/$FILENAME.$EXT

$STRING is typically of the form dl or $USER.dl.

If these formats are not available, and the application is Mac-exclusive (otherwise a command-line download defaults to the Windows version) we prefer the use of this format:

http://sourceforge.net/projects/$PROJECTNAME/files/latest/download

Personal Hosting Such as Dropbox

URLs from dropbox.com or cl.ly/cloudapp.com are not readily distinguishable as being controlled by the original software vendor. These URLs should be used only when given as such on the official project website.

Also make sure to give the URL for the binary download itself, rather than a preview page. (See https://www.dropbox.com/help/201/en.)

Some Providers Block Command-line Downloads

Some hosting providers actively block command-line HTTP clients (example: FossHub). Such URLs cannot be used in Casks.

Vendor URLs Are Preferred

When possible, it is best to use a download URL from the original developer or vendor, rather than an aggregator such as macupdate.com.

Cask Token Details

If a token conflicts with an already-existing Cask, authors should manually make the new token unique by prepending the vendor name. Example: unison.rb and panic-unison.rb.

If possible, avoid creating tokens which differ only by the placement of hyphens.

To generate a token manually, or to learn about exceptions for unusual cases, see cask_token_reference.md.

Archives With Subfolders

When a downloaded archive expands to a subfolder, the subfolder name must be included in the app value.

Example:

  1. Texmaker is downloaded to the file TexmakerMacosxLion.zip.
  2. TexmakerMacosxLion.zip unzips to a folder called TexmakerMacosxLion.
  3. The folder TexmakerMacosxLion contains the application texmaker.app.
  4. So, the app stanza should include the subfolder as a relative path:
app 'TexmakerMacosxLion/texmaker.app'

Style guide

All Casks and code in the homebrew-cask project should be indented using two spaces (never tabs).

If relevant, you may also use string manipulations to improve the maintainability of your Cask. Here’s an example from Lynkeos.app:

cask 'lynkeos' do
  version '2.10'
  sha256 'bd27055c51575555a1c8fe546cf057c57c0e45ea5d252510847277734dc550a4'

  url "http://downloads.sourceforge.net/project/lynkeos/lynkeos/#{version}/Lynkeos-App-#{version.gsub('.', '-')}.zip"
  name 'Lynkeos'
  homepage 'http://lynkeos.sourceforge.net/'
  license :gpl

  app "Lynkeos-App-#{version.gsub('.', '-')}/Lynkeos.app"
end

Testing Your New Cask

Give it a shot with brew cask install my-new-cask

Did it install? If something went wrong, brew cask uninstall my-new-cask and edit your Cask to fix it.

If everything looks good, you’ll also want to make sure your Cask passes audit with:

brew cask audit my-new-cask --download

You should also check stylistic details with the rubocop gem:

cd "$(brew --repository)/Library/Taps/caskroom/homebrew-cask"
bundle install
bundle exec rubocop --auto-correct Casks/my-new-cask.rb

Keep in mind all of these checks will be made when you submit your PR, so by doing them in advance you’re saving everyone a lot of time and trouble.

If your application and homebrew-cask do not work well together, feel free to file an issue after checking out open issues.

Finding a Home For Your Cask

We maintain separate Taps for different types of binaries. Our nomenclature is:

  • Stable: The latest version provided by the developer defined by them as such.
  • Beta, Development, Unstable: Subsequent versions to stable, yet incomplete and under development, aiming to eventually become the new stable.
  • Nightly: Constantly up-to-date versions of the current development state.
  • Legacy: Any stable version that is not the most recent.
  • Alternative: Alternative edition of an existing app, by the same vendor (developer editions, community editions, pro editions, …).
  • Regional, Localized: Any version that isn’t the US English one, when that exists.
  • Trial: Date-limited version that stops working entirely after it expires, requiring payment to lift the limitation.
  • Freemium: Gratis version that works indefinitely but with limitations that can be removed by paying.
  • Fork: An alternate version of an existing project, with a based-on but modified source and binary.
  • Unofficial: An allegedly unmodified compiled binary, by a third-party, of a binary that has no existing build by the owner of the source code.
  • Vendorless: A binary distributed without an official website, like a forum posting.
  • Walled: When the download URL is both behind a login/registration form and from a host that differs from the homepage.

Stable Versions

Stable versions live in the main repository at caskroom/homebrew-cask. They should run on the latest release of OS X or the previous point release (in 2015, for example, that meant El Capitan and Yosemite).

But There Is No Stable Version!

When an App is only available as beta, development, or unstable versions, or in cases where such a version is the general standard, then said version can go into the main repo.

Beta, Unstable, Development, Nightly, Legacy, or Alternative Versions

When an App’s principal stable version already exists in the main repo, alternative versions should be submitted to caskroom/homebrew-versions.

Regional and Localized

When an App exists in more than one language or has different regional editions, the US English one belongs in the main repo, and all the others in caskroom/homebrew-versions. When not already part of the name of the app, a regional identifier and a language code are to be appended to the Cask’s token (both when available, or just the appropriate one when not).

Trial and Freemium Versions

Before submitting a trial, make sure it can be made into a full working version without the need to be redownloaded. If an App provides a trial but the only way to buy the full version is via the Mac App Store, it does not belong in any of the official repos. Freemium versions are fine.

Forks and Apps with conflicting names

Forks should have the vendor’s name as a prefix on the cask’s file name and token. For unrelated apps that share a name, the most popular one (usually the one already present) stays unprefixed. Since this can be subjective, if you disagree with a decision open an issue and make your case to the maintainers.

Unofficial, Vendorless, and Walled Builds

Please submit these to caskroom/homebrew-unofficial. If you’ve made an unofficial build and need a place to host it, contact our sister project alehouse.

Fonts

Font casks live in the caskroom/homebrew-fonts repository. See the font repo CONTRIBUTING.md for details.

Submitting Your Changes

Hop into your Tap and check to make sure your new Cask is there:

$ cd "$(brew --repository)"/Library/Taps/caskroom/homebrew-cask
$ git status
# On branch master
# Untracked files:
#   (use "git add <file>..." to include in what will be committed)
#
#       Casks/my-new-cask.rb

So far, so good. Now make a feature branch that you’ll use in your pull request:

$ git checkout -b my-new-cask
Switched to a new branch 'my-new-cask'

Stage your Cask with git add Casks/my-new-cask.rb. You can view the changes that are to be committed with git diff --cached.

Commit your changes with git commit -v.

Commit Messages

For any git project, some good rules for commit messages are:

  • The first line is commit summary, 50 characters or less,
  • Followed by an empty line
  • Followed by an explanation of the commit, wrapped to 72 characters.

See a note about git commit messages for more.

The first line of a commit message becomes the title of a pull request on GitHub, like the subject line of an email. Including the key info in the first line will help us respond faster to your pull.

For Cask commits in the homebrew-cask project, we like to include the Application name, version number (or :latest), and purpose of the commit in the first line.

Examples of good, clear commit summaries:

  • Add Transmission.app v1.0
  • Upgrade Transmission.app to v2.82
  • Fix checksum in Transmission.app Cask
  • Add CodeBox Latest

Examples of difficult, unclear commit summaries:

  • Upgrade to v2.82
  • Checksum was bad

Pushing

Push your changes to your GitHub account:

$ github_user='<my-github-username>'
$ git push "$github_user" my-new-cask

If you are using GitHub two-factor authentication and set your remote repository as HTTPS you will need to set up a personal access token and use that instead of your password. Further information here.

Squashing

If your pull request has multiple commits which revise the same lines of code, or if you make some changes after comments from one of the maintainers, it is better to squash those commits together into one logical unit.

But you don’t always have to squash — it is fine for a pull request to contain multiple commits when there is a logical reason for the separation.

Filing a Pull Request on GitHub

Now go to your GitHub repository at https://github.com/my-github-username/homebrew-cask, switch branch to your topic branch and click the New Pull Request button. If it isn't automatically selected, choose to compare across forks. The base fork should be caskroom/homebrew-cask @ master, and the head fork should be my-github-username/homebrew-cask @ my-new-cask. You can also add any further comments to your pull request at this stage.

Congratulations! You are done now, and your Cask should be pulled in or otherwise noticed in a while. If a maintainer suggests some changes, just make them on the my-new-cask branch locally, squash, and push.

Cleaning up

After your Pull Request is submitted, you might want to get yourself back onto master, so that brew update will pull down new Casks properly.

cd "$(brew --repository)"/Library/Taps/caskroom/homebrew-cask
git checkout master

Neat and tidy!

<3 THANK YOU! <3