Skip to content

Commit fdabcaf

Browse files
Merge pull request #20388 from Homebrew/docs-cask-signing
docs: mention signing in deprecation criteria
2 parents 726f83c + 0f06a17 commit fdabcaf

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

docs/Deprecating-Disabling-and-Removing-Casks.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,15 @@ If a user attempts to install a deprecated cask, they will be shown a warning me
2020

2121
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.
2222

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.
2424

2525
Casks should only be deprecated if at least one of the following are true:
2626

27+
- the software installed by the cask is unsigned or does not meet signature requirements for supported OS versions
2728
- 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
3030
- 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/)
3132

3233
To deprecate a cask, add a `deprecate!` call. This call should include a deprecation date in the ISO 8601 format and a deprecation reason:
3334

@@ -39,7 +40,7 @@ The `date` parameter should be set to the date that the deprecation period shoul
3940

4041
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.
4142

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.
4344

4445
```ruby
4546
deprecate! date: "YYYY-MM-DD", because: :reason, replacement_formula: "foo"
@@ -72,7 +73,7 @@ The `date` parameter should be set to the date that the reason for disabling cam
7273

7374
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.
7475

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.
7677

7778
```ruby
7879
disable! date: "YYYY-MM-DD", because: :reason, replacement_cask: "foo"

docs/Deprecating-Disabling-and-Removing-Formulae.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ The most common reasons for deprecation are when the upstream project is depreca
2525
Formulae should only be deprecated if at least one of the following are true:
2626

2727
- 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
3029
- 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/)
3131

3232
Formulae with dependents should not be deprecated unless all dependents are also deprecated.
3333

@@ -41,7 +41,7 @@ The `date` parameter should be set to the date that the deprecation period shoul
4141

4242
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.
4343

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.
4545

4646
```ruby
4747
deprecate! date: "YYYY-MM-DD", because: :reason, replacement_formula: "foo"
@@ -74,7 +74,7 @@ The `date` parameter should be set to the date that the reason for disabling cam
7474

7575
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.
7676

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.
7878

7979
```ruby
8080
disable! date: "YYYY-MM-DD", because: :reason, replacement_cask: "foo"

0 commit comments

Comments
 (0)