mirrors/brew
1
0
Fork 0
mirror of https://github.com/Homebrew/brew.git synced 2025-07-14 16:09:03 +08:00
Code Issues Packages Projects Releases Wiki Activity
brew/docs/Acceptable-Casks.md

133 lines
14 KiB
Markdown
Raw Normal View History

Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
# Acceptable Casks
Contributors docs: adjust line breaks
2022-04-19 21:28:17 -04:00
Some casks should not go in [homebrew/cask](https://github.com/Homebrew/homebrew-cask). But there are additional [Interesting Taps and Forks](Interesting-Taps-and-Forks.md) and anyone can [start their own](How-to-Create-and-Maintain-a-Tap.md)!
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
docs: add Table of Contents to selected pages
2022-12-29 12:48:27 -05:00
* Table of Contents
{:toc}
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
## Finding a Home For Your Cask
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
We maintain separate taps for different types of binaries. Our nomenclature is:
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
docs: add Table of Contents to selected pages
2022-12-29 12:48:27 -05:00
* **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**. Also includes alternate versions specifically targeted at developers.
* **Nightly**: Constantly up-to-date versions of the current development state.
* **Legacy**: Any **stable** version that is not the most recent.
* **Regional, Localized**: Any version that isn’t the US English one, when that exists.
* **Trial**: Time-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 via means other than 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.
* **Font**: Data file containing a set of glyphs, characters, or symbols, that changes typed text.
* **Driver**: Software to make a hardware peripheral recognisable and usable by the system. If the software is useless without the peripheral, it’s considered a driver.
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
### Stable versions
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
docs: Bump stable cask OS versions
2022-11-04 15:00:04 -07:00
Stable versions live in the main repository at [Homebrew/homebrew-cask](https://github.com/Homebrew/homebrew-cask). They should run on the latest release of macOS or the previous point release (Monterey and Ventura as of late 2022).
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
#### But there is no Stable version!
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
Update Acceptable-Casks.md
2021-08-19 02:41:14 +01:00
When software is only available as a beta, development, or unstable version, its cask can go in the main repo. When stable versions become available, only those will be accepted as subsequent updates.
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
### Beta, Unstable, Development, Nightly, or Legacy
Update Acceptable-Casks.md
2021-08-19 02:41:14 +01:00
Alternative versions should be submitted to [Homebrew/homebrew-cask-versions](https://github.com/Homebrew/homebrew-cask-versions).
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
### Regional and Localized
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
When an app exists in more than one language or has different regional editions, [the `language` stanza should be used to switch between languages or regions](https://docs.brew.sh/Cask-Cookbook#stanza-language).
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
### Trial and Freemium versions
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
Before submitting a trial, make sure it can be made into a full working version without needing 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.
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
### Forks and apps with conflicting names
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
Forks must have the vendor’s name as a prefix on the cask’s filename and token. If the original software is discontinued, forks still need to follow this rule so as to not be surprising to the user. There are two exceptions which allow the fork to replace the main cask:
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
1. The original discontinued software recommends that fork.
2. The fork is so overwhelmingly popular that it surpasses the original and is now the de facto project when people think of the name.
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
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.
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
### Unofficial, Vendorless, and Walled builds
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
We do not accept these casks since they involve a higher-than-normal security risk.
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
### Fonts
Contributors docs: adjust line breaks
2022-04-19 21:28:17 -04:00
Font casks live in the [Homebrew/homebrew-cask-fonts](https://github.com/Homebrew/homebrew-cask-fonts) repository. See the fonts repo [CONTRIBUTING.md](https://github.com/Homebrew/homebrew-cask-fonts/blob/HEAD/CONTRIBUTING.md) for details.
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
### Drivers
Contributors docs: adjust line breaks
2022-04-19 21:28:17 -04:00
Driver casks live in the [Homebrew/homebrew-cask-drivers](https://github.com/Homebrew/homebrew-cask-drivers) repository. See the drivers repo [CONTRIBUTING.md](https://github.com/Homebrew/homebrew-cask-drivers/blob/master/CONTRIBUTING.md) for details.
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
## Apps that bundle malware
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
Unfortunately, in the world of software there are bad actors that bundle malware with their apps. Even so, Homebrew Cask has long decided it will not be an active gatekeeper ([macOS already has one](https://support.apple.com/en-us/HT202491)) and [users are expected to know about the software they are installing](#homebrew-cask-is-not-a-discoverability-service). This means we will not always remove casks that link to these apps, in part because there is no clear line between useful app, potentially unwanted program, and the different shades of malware—what is useful to one user may be seen as malicious by another.
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
Acceptable-Casks.md: first pass after moving
2021-02-12 00:37:07 +00:00
But we’d still like for users to enjoy some kind of protection while minimising occurrences of legitimate developers being branded as malware carriers. To do so, we evaluate casks on a case-by-case basis and any user is free to bring a potential malware case to our attention. However, it is important to never forget the last line of defence is *always* the user.
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
If an app that bundles malware was not signed with an Apple Developer ID and you purposefully disabled or bypassed Gatekeeper, no action will be taken on our part. When you disable security features, you do so at your own risk. If, however, an app that bundles malware is signed, Apple can revoke its permissions and it will no longer run on the computers of users that keep security features on—we all benefit, Homebrew Cask users or not. To report a signed app that bundles malware, use [Apple’s Feedback Assistant](https://feedbackassistant.apple.com).
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
We are also open to removing casks where we feel there is enough evidence that the app is malicious. To suggest a cask for removal, submit a pull request to delete it along with your reasoning. Typically, this will mean presenting a [VirusTotal](https://www.virustotal.com) scan of the app showing it is malicious, ideally with some other reporting indicating it’s not a false positive.
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
Likewise, software which provides both “clean” and malware-infested versions might be removed from the repo—even if we could have access to the *good* version—if its developers push for users to install the *bad* version. We do so because in these cases there’s a higher than normal risk that both versions are (or will soon become) compromised in some manner.
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
If a cask you depend on was removed due to these rules, fear not. Removal of a cask from the official repositories means we won’t support it, but you can do so by [hosting your own tap](How-to-Create-and-Maintain-a-Tap.md).
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
## Exceptions to the notability threshold
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
Casks which do not reach a minimum notability threshold (see [Rejected Casks](#rejected-casks)) aren’t accepted in the main repositories because the increased maintenance burden doesn’t justify the poor usage numbers they will likely get. This notability check is performed automatically by the audit commands we provide, but its decisions aren’t set in stone. A cask which fails the notability check can be added if it is:
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
1. A popular app that has its own website but the developers use GitHub for hosting the binaries. That repository won’t be notable but the app may be.
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
2. Submitted by a maintainer or prolific contributor. A big part of the reasoning for the notability rule is unpopular software garners less attention and the cask gets abandoned, outdated, and broken. Someone with a proven investment in Hombrew Cask is less likely to let that happen for software they depend on.
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
3. A piece of software that was recently released to great fanfare—everyone is talking about it on Twitter and Hacker News and we’ve even gotten multiple premature submissions for it. That’d be a clear case of an app that will reach the threshold in no time so that’s a PR we won’t close immediately (but may wait to merge).
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
Note that none of these exceptions is a guarantee for inclusion, but examples of situations where we may take a second look.
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
## Homebrew Cask is not a discoverability service
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
From the inception of Homebrew Cask, various requests have fallen under the umbrella of this reply. Though a somewhat popular request, after careful consideration on multiple occasions we’ve always come back to the same conclusion: we’re not a discoverability service and our users are expected to have reasonable knowledge about the apps they’re installing through us before doing so. For example, [grouping casks by categories](https://github.com/Homebrew/homebrew-cask/issues/5425) is not within the scope of the project.
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
Amongst other things, the logistics of such requests are unsustainable for Homebrew Cask. Before making a request of this nature, you must read through previous related issues, as well as any other issues they link to, to get a full understanding of why that is the case, and why “but project *x* does *y*” arguments aren’t applicable, and how not every package manager is the same.
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
You should also be able to present clear actionable fixes to those concerns. Simply asking for it without solutions will get your issue closed.
Acceptable-Casks.md: improve readability Move definitions next to their terms, so the reader immediately understands the terms used. Also grammar fixes in the second half.
2021-04-19 21:41:47 +08:00
However, there is a difference between discoverability (finding new apps you didn’t know about) and searchability (identifying the app you know about and want to install). While the former is unlikely to ever become part of our goals, the latter is indeed important to us, and we continue to work on it.
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
## Rejected Casks
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
Before submitting a cask to any of our repos, you must read our [documentation on acceptable casks](#finding-a-home-for-your-cask) and perform a (at least quick) search to see if there were any previous attempts to introduce it.
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
Common reasons to reject a cask entirely:
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
docs: add Table of Contents to selected pages
2022-12-29 12:48:27 -05:00
* We have strong reasons to believe including the cask can put the whole project at risk. Happened only once so far, [with Popcorn Time](https://github.com/Homebrew/homebrew-cask/pull/3954).
* Cask is unreasonably difficult to maintain. Examples have included [Audacity](https://github.com/Homebrew/homebrew-cask/pull/27517) and [older Java development casks](https://github.com/Homebrew/homebrew-cask/issues/57387).
* App is a trial version, and the only way to acquire the full version is through the Mac App Store.
* Similarly (and trickier to spot), the app has moved to the Mac App Store but still provides old versions via direct download. We reject these in all official repos so users don’t get stuck using an old version, wrongly thinking they’re using the most up-to-date one (which, amongst other things, might be a security risk).
* App is both open-source and CLI-only (i.e. it only uses the `binary` artifact). In that case, and [in the spirit of deduplication](https://github.com/Homebrew/homebrew-cask/issues/15603), submit it first to [homebrew/core](https://github.com/Homebrew/homebrew-core) as a formula that builds from source. If it is rejected, you may then try again as a cask (link to the issue from your pull request so we can see the discussion and reasoning for rejection).
* App is open-source and has a GUI but no compiled versions (or only old ones) are provided. It’s better to have them in [homebrew/core](https://github.com/Homebrew/homebrew-core) so users don’t get perpetually outdated versions. See [`gedit`](https://github.com/Homebrew/homebrew-cask/pull/23360) for example.
* Cask has been rejected before due to an issue we cannot fix, and the new submission doesn’t fix that. An example would be the [first submission of `soapui`](https://github.com/Homebrew/homebrew-cask/pull/4939), whose installation problems were not fixed in the two [subsequent](https://github.com/Homebrew/homebrew-cask/pull/9969) [submissions](https://github.com/Homebrew/homebrew-cask/pull/10606).
* Cask is a duplicate. These submissions mostly occur when the [token reference](https://docs.brew.sh/Cask-Cookbook#token-reference) was not followed.
* Cask has a download URL that is both behind a login/registration form and from a host that differs from the homepage, meaning users can’t easily verify its authenticity.
* App is unmaintained, i.e. no releases in the last year, or [explicitly discontinued](https://github.com/Homebrew/homebrew-cask/pull/22699).
* App is too obscure. Examples:
* An app from a code repository that is not notable enough (under 30 forks, 30 watchers, 75 stars).
* [Electronic Identification (eID) software](https://github.com/Homebrew/homebrew-cask/issues/59021).
* App has no information on its homepage (example: a GitHub repository without a README).
* The author has [specifically asked us not to include it](https://github.com/Homebrew/homebrew-cask/pull/5342).
* App requires [SIP to be disabled](https://github.com/Homebrew/homebrew-cask/pull/41890) to be installed and/or used.
* App installer is a `pkg` that requires [`allow_untrusted: true`](https://docs.brew.sh/Cask-Cookbook#pkg-allow_untrusted).
* App fails with GateKeeper enabled on Homebrew supported macOS versions and platforms (e.g. unsigned apps fail on Macs with Apple silicon/ARM).
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
Common reasons to reject a cask from the main repo:
Docs: Migrate casks FAQ
2021-02-09 13:00:45 +01:00
docs: add Table of Contents to selected pages
2022-12-29 12:48:27 -05:00
* Cask was submitted to the wrong repo. When drafting a cask, consult [Finding a Home For Your Cask](#finding-a-home-for-your-cask) to see where it belongs.
Update Acceptable-Casks.md
2021-08-19 02:41:14 +01:00
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
### No cask is guaranteed to be accepted
Update Acceptable-Casks.md
2021-08-19 02:41:14 +01:00
Contributors docs: content & formatting updates Update How-To-Open-a-Homebrew-Pull-Request.md Update Acceptable-Formulae.md Update Acceptable-Casks.md Update License-Guidelines.md Update Versions.md Update Versions.md Update Deprecating-Disabling-and-Removing-Formulae.md Update Node-for-Formula-Authors.md Update Python-for-Formula-Authors.md Update Brew-Livecheck.md Update Migrating-A-Formula-To-A-Tap.md Update Rename-A-Formula.md Update How-to-Create-and-Maintain-a-Tap.md Update Brew-Test-Bot.md Update Typechecking.md
2022-10-19 13:28:43 -04:00
Follow the guidelines above and your submission has a great chance of being accepted. But remember that documentation tends to lag behind current decision-making and we can’t predict every case. Maintainers may override these rules when experience tells us it will lead to a better overall Homebrew.
Reference in New Issue Copy Permalink