You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/Deprecating-Disabling-and-Removing-Casks.md
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,14 +20,15 @@ If a user attempts to install a deprecated cask, they will be shown a warning me
20
20
21
21
A cask should be deprecated to indicate to users that the cask should not be used and will be disabled in the future. Deprecated casks should continue to be maintained by the Homebrew maintainers if they continue to be installable. If this is not possible, they should be immediately disabled.
22
22
23
-
The most common reasons for deprecation are when the upstream project is deprecated, unmaintained or archived.
23
+
The most common reasons for deprecation are when the upstream project is unsigned, deprecated, unmaintained or archived.
24
24
25
25
Casks should only be deprecated if at least one of the following are true:
26
26
27
+
- the software installed by the cask is unsigned or does not meet signature requirements for supported OS versions
27
28
- the software installed by the cask cannot be run on any supported OS versions
28
-
- the cask has outstanding CVEs
29
-
- the cask has [zero installs in the last 90 days](https://formulae.brew.sh/analytics/cask-install/90d/)
29
+
- the software installed by the cask has outstanding CVEs
30
30
- the software installed by the cask has been discontinued or abandoned upstream
31
+
- the cask has [zero installs in the last 90 days](https://formulae.brew.sh/analytics/cask-install/90d/)
31
32
32
33
To deprecate a cask, add a `deprecate!` call. This call should include a deprecation date in the ISO 8601 format and a deprecation reason:
33
34
@@ -39,7 +40,7 @@ The `date` parameter should be set to the date that the deprecation period shoul
39
40
40
41
The `because` parameter can be a preset reason (using a symbol) or a custom reason. See the [Deprecate and Disable Reasons](#deprecate-and-disable-reasons) section below for more details about the `because` parameter.
41
42
42
-
An optional `replacement_formula` or `replacement_cask` parameter may also be specified to suggest a replacement formula or cask to the user. The value of the parameter is a string.
43
+
An optional `replacement_formula` or `replacement_cask` parameter may also be specified to suggest a replacement formula or cask to the user. The value for the parameter is a string.
@@ -72,7 +73,7 @@ The `date` parameter should be set to the date that the reason for disabling cam
72
73
73
74
The `because` parameter can be a preset reason (using a symbol) or a custom reason. See the [Deprecate and Disable Reasons](#deprecate-and-disable-reasons) section below for more details about the `because` parameter.
74
75
75
-
Similar to deprecated casks, an optional `replacement_formula` or `replacement_cask` parameter may also be specified for disabled casks to suggest a replacement formula or cask to the user. The value of the parameter is a string.
76
+
Similar to deprecated casks, an optional `replacement_formula` or `replacement_cask` parameter may also be specified for disabled casks to suggest a replacement formula or cask to the user. The value for the parameter is a string.
Copy file name to clipboardExpand all lines: docs/Deprecating-Disabling-and-Removing-Formulae.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,9 +25,9 @@ The most common reasons for deprecation are when the upstream project is depreca
25
25
Formulae should only be deprecated if at least one of the following are true:
26
26
27
27
- the formula does not build on any supported OS versions
28
-
- the formula has outstanding CVEs
29
-
- the formula has [zero installs in the last 90 days](https://formulae.brew.sh/analytics/install/90d/)
28
+
- the software installed by the formula has outstanding CVEs
30
29
- the software installed by the formula has been discontinued or abandoned upstream
30
+
- the formula has [zero installs in the last 90 days](https://formulae.brew.sh/analytics/install/90d/)
31
31
32
32
Formulae with dependents should not be deprecated unless all dependents are also deprecated.
33
33
@@ -41,7 +41,7 @@ The `date` parameter should be set to the date that the deprecation period shoul
41
41
42
42
The `because` parameter can be a preset reason (using a symbol) or a custom reason. See the [Deprecate and Disable Reasons](#deprecate-and-disable-reasons) section below for more details about the `because` parameter.
43
43
44
-
An optional `replacement_formula` or `replacement_cask` parameter may also be specified to suggest a replacement formula or cask to the user. The value of the parameter is a string.
44
+
An optional `replacement_formula` or `replacement_cask` parameter may also be specified to suggest a replacement formula or cask to the user. The value for the parameter is a string.
@@ -74,7 +74,7 @@ The `date` parameter should be set to the date that the reason for disabling cam
74
74
75
75
The `because` parameter can be a preset reason (using a symbol) or a custom reason. See the [Deprecate and Disable Reasons](#deprecate-and-disable-reasons) section below for more details about the `because` parameter.
76
76
77
-
Similar to deprecated formulae, an optional `replacement_formula` or `replacement_cask` parameter may also be specified for disabled formulae to suggest a replacement formula or cask to the user. The value of the parameter is a string.
77
+
Similar to deprecated formulae, an optional `replacement_formula` or `replacement_cask` parameter may also be specified for disabled formulae to suggest a replacement formula or cask to the user. The value for the parameter is a string.
0 commit comments