admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

Merge pull request #12727 from carlocab/deprecate-disable

Browse Source 
Update documentation on deprecating and disabling formulae
This commit is contained in:
Carlo Cabrera 2022-01-18 19:27:52 +08:00 committed by GitHub
commit 7366f3540e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/Deprecating-Disabling-and-Removing-Formulae.md
View File

@ -18,6 +18,12 @@ A formula should be deprecated to indicate to users that the formula should not
The most common reasons for deprecation are when the upstream project is deprecated, unmaintained, or archived.
Formulae with dependents may be deprecated only if at least one of the following are true:
- its dependents are all deprecated
- the formula does not build on any of our supported macOS versions and on Linux
- the formula has outstanding CVEs
To deprecate a formula, add a `deprecate!` call. This call should include a deprecation date (in the ISO 8601 format) and a deprecation reason:
```ruby
@ -41,6 +47,8 @@ The most common reasons for disabling a formula are:
- the upstream repository has been removed
- the project has no license
Formulae should not be disabled without a deprecation period of at least three months unless the circumstances are exceptional (e.g. the formula does not build on any supported macOS version or Linux). Popular formulae should have longer deprecation periods. The popularity of a formula should be based on our analytics data.
**Note: disabled formulae in homebrew/core will be automatically removed one year after their disable date**
To disable a formula, add a `disable!` call. This call should include a deprecation date (in the ISO 8601 format) and a deprecation reason: