Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

deprecate_disable: add cask deprecate/disable reasons #16743

Merged
merged 3 commits into from
Feb 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion Library/Homebrew/deprecate_disable.rb
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@ module DeprecateDisable
}.freeze

CASK_DEPRECATE_DISABLE_REASONS = {
discontinued: "is discontinued upstream",
discontinued: "is discontinued upstream",
no_longer_available: "is no longer available upstream",
unmaintained: "is not maintained upstream",
}.freeze

def type(formula_or_cask)
Expand Down
2 changes: 2 additions & 0 deletions docs/Deprecating-Disabling-and-Removing-Casks.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@ When a cask is deprecated or disabled, a reason explaining the action must be pr
There are two ways to indicate the reason. The preferred way is to use a pre-existing symbol to indicate the reason. The available symbols are listed below and can be found in the [`DeprecateDisable` module](https://github.com/Homebrew/brew/blob/master/Library/Homebrew/deprecate_disable.rb):

- `:discontinued`: the cask is discontinued upstream
- `:no_longer_available`: the cask is no longer available upstream
- `:unmaintained`: the cask is not maintained upstream

These reasons can be specified by their symbols (the comments show the message that will be displayed to users):

Expand Down