Skip to content

Commit

Permalink
docs: update for Homebrew/cask-fonts deprecation
Browse files Browse the repository at this point in the history
Signed-off-by: Patrick Linnane <patrick@linnane.io>
  • Loading branch information
p-linnane committed May 16, 2024
1 parent 1fac683 commit 773dbfa
Show file tree
Hide file tree
Showing 12 changed files with 15 additions and 39 deletions.
15 changes: 4 additions & 11 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,6 @@ jobs:
run: |
brew tap homebrew/aliases
brew tap homebrew/bundle
brew tap homebrew/cask-fonts
brew tap homebrew/command-not-found
brew tap homebrew/formula-analytics
brew tap homebrew/portable-ruby
Expand All @@ -130,10 +129,9 @@ jobs:
homebrew/formula-analytics \
homebrew/portable-ruby
- name: Run brew style on cask taps
- name: Run brew style on homebrew/cask
run: |
brew style homebrew/cask \
homebrew/cask-fonts
brew style homebrew/cask
formula-audit:
name: formula audit
Expand Down Expand Up @@ -172,17 +170,12 @@ jobs:
cask: true
test-bot: false

- name: Set up Homebrew all cask taps
run: |
brew tap homebrew/cask-fonts
- name: Run brew readall on all casks
run: brew readall --os=all --arch=all homebrew/cask homebrew/cask-fonts
run: brew readall --os=all --arch=all homebrew/cask

- name: Run brew audit --skip-style on casks
- name: Run brew audit --skip-style on homebrew/cask
run: |
brew audit --skip-style --except=version --tap=homebrew/cask
brew audit --skip-style --except=version --tap=homebrew/cask-fonts
- name: Generate formula API
run: brew generate-formula-api --dry-run
Expand Down
2 changes: 1 addition & 1 deletion Library/Homebrew/cask/audit.rb
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ def audit_required_stanzas
def audit_description
# Fonts seldom benefit from descriptions and requiring them disproportionately
# increases the maintenance burden.
return if cask.tap == "homebrew/cask-fonts"
return if cask.tap == "homebrew/cask" && cask.token.include?("font-")

add_error("Cask should have a description. Please add a `desc` stanza.", strict_only: true) if cask.desc.blank?
end
Expand Down
2 changes: 1 addition & 1 deletion Library/Homebrew/official_taps.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@

OFFICIAL_CASK_TAPS = %w[
cask
cask-fonts
].freeze

OFFICIAL_CMD_TAPS = {
Expand All @@ -19,6 +18,7 @@
binary
cask-drivers
cask-eid
cask-fonts
cask-versions
completions
devel-only
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
end

it "returns nil for full name with invalid tap" do
expect(described_class.try_new("homebrew/cask-fonts/#{token}")).to be_nil
expect(described_class.try_new("homebrew/foo/#{token}")).to be_nil
end
end
end
Expand Down
2 changes: 1 addition & 1 deletion completions/fish/brew.fish
Original file line number Diff line number Diff line change
Expand Up @@ -532,7 +532,7 @@ __fish_brew_complete_arg 'contributions' -l debug -d 'Display any debugging info
__fish_brew_complete_arg 'contributions' -l from -d 'Date (ISO-8601 format) to start searching contributions. Omitting this flag searches the last year'
__fish_brew_complete_arg 'contributions' -l help -d 'Show this message'
__fish_brew_complete_arg 'contributions' -l quiet -d 'Make some output more quiet'
__fish_brew_complete_arg 'contributions' -l repositories -d 'Specify a comma-separated list of repositories to search. Supported repositories: `brew`, `core`, `cask`, `aliases`, `bundle`, `command-not-found`, `test-bot`, `services` and `cask-fonts`. Omitting this flag, or specifying `--repositories=primary`, searches only the main repositories: brew,core,cask. Specifying `--repositories=all`, searches all repositories. '
__fish_brew_complete_arg 'contributions' -l repositories -d 'Specify a comma-separated list of repositories to search. Supported repositories: `brew`, `core`, `cask`, `aliases`, `bundle`, `command-not-found`, `test-bot` and `services`. Omitting this flag, or specifying `--repositories=primary`, searches only the main repositories: brew,core,cask. Specifying `--repositories=all`, searches all repositories. '
__fish_brew_complete_arg 'contributions' -l to -d 'Date (ISO-8601 format) to stop searching contributions'
__fish_brew_complete_arg 'contributions' -l user -d 'Specify a comma-separated list of GitHub usernames or email addresses to find contributions from. Omitting this flag searches maintainers'
__fish_brew_complete_arg 'contributions' -l verbose -d 'Make some output more verbose'
Expand Down
2 changes: 1 addition & 1 deletion completions/zsh/_brew
Original file line number Diff line number Diff line change
Expand Up @@ -683,7 +683,7 @@ _brew_contributions() {
'--from[Date (ISO-8601 format) to start searching contributions. Omitting this flag searches the last year]' \
'--help[Show this message]' \
'--quiet[Make some output more quiet]' \
'--repositories[Specify a comma-separated list of repositories to search. Supported repositories: `brew`, `core`, `cask`, `aliases`, `bundle`, `command-not-found`, `test-bot`, `services` and `cask-fonts`. Omitting this flag, or specifying `--repositories=primary`, searches only the main repositories: brew,core,cask. Specifying `--repositories=all`, searches all repositories. ]' \
'--repositories[Specify a comma-separated list of repositories to search. Supported repositories: `brew`, `core`, `cask`, `aliases`, `bundle`, `command-not-found`, `test-bot` and `services`. Omitting this flag, or specifying `--repositories=primary`, searches only the main repositories: brew,core,cask. Specifying `--repositories=all`, searches all repositories. ]' \
'--to[Date (ISO-8601 format) to stop searching contributions]' \
'--user[Specify a comma-separated list of GitHub usernames or email addresses to find contributions from. Omitting this flag searches maintainers]' \
'--verbose[Make some output more verbose]'
Expand Down
4 changes: 0 additions & 4 deletions docs/Acceptable-Casks.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,6 @@ For unrelated apps that share a name, the most popular one (usually the one alre

We do not accept these casks since they involve a higher-than-normal security risk.

### Fonts

Font casks live in the [Homebrew/homebrew-cask-fonts](https://github.com/Homebrew/homebrew-cask-fonts) repository. See the `homebrew/cask-fonts` repository [CONTRIBUTING.md](https://github.com/Homebrew/homebrew-cask-fonts/blob/HEAD/CONTRIBUTING.md) for details.

## Apps that bundle malware

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鈥攚hat is useful to one user may be seen as malicious by another.
Expand Down
7 changes: 0 additions & 7 deletions docs/Cask-Cookbook.md
Original file line number Diff line number Diff line change
Expand Up @@ -1285,7 +1285,6 @@ This section describes the algorithm implemented in the `generate_cask_token` sc
* [Cask Filenames](#cask-filenames)
* [Cask Headers](#cask-headers)
* [Cask Token Examples](#cask-token-examples)
* [Tap-Specific Cask Token Examples](#tap-specific-cask-token-examples)
* [Special Affixes](#special-affixes)

### Purpose
Expand Down Expand Up @@ -1411,12 +1410,6 @@ For versioned/development channel casks:
| `vlc` | Nightly Channel | `vlc@nightly` | `vlc@nightly.rb` |
| `carbon-copy-cloner` | Pinned to version 5 | `carbon-copy-cloner@5`| `carbon-copy-cloner@5.rb` |

#### Tap-specific cask token examples

Cask taps have naming conventions specific to each tap.

* [Homebrew/cask-fonts](https://github.com/Homebrew/homebrew-cask-fonts/blob/HEAD/CONTRIBUTING.md#naming-font-casks)

### Special affixes

A few situations require a prefix or suffix to be added to the token.
Expand Down
7 changes: 1 addition & 6 deletions docs/Homebrew-homebrew-cask-Maintainer-Guide.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
# Homebrew/homebrew-cask Maintainer Guide

This guide is intended to help maintainers effectively maintain the cask repositories. It is meant to be used in conjunction with the more generic [Maintainer Guidelines](Maintainer-Guidelines.md).

This guide applies to both of the cask repositories:

- [Homebrew/homebrew-cask](https://github.com/Homebrew/homebrew-cask): The main cask repository
- [Homebrew/homebrew-cask-fonts](https://github.com/Homebrew/homebrew-cask-fonts): Casks of fonts
This guide is intended to help maintainers effectively maintain the cask repository. It is meant to be used in conjunction with the more generic [Maintainer Guidelines](Maintainer-Guidelines.md).

## Common Situations

Expand Down
2 changes: 1 addition & 1 deletion docs/Maintainer-Guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ All Homebrew maintainers are encouraged to contribute to all parts of the projec
- `brew` maintainers: this team maintains the [`Homebrew/brew`](https://github.com/Homebrew/brew) repository. See the [Homebrew/brew Maintainer Guide](Homebrew-brew-Maintainer-Guide.md) for more details about being a `brew` maintainer.
- Core maintainers: this team maintains the [`Homebrew/homebrew-core`](https://github.com/Homebrew/homebrew-core) repository. See the [Homebrew/homebrew-core Maintainer Guide](Homebrew-homebrew-core-Maintainer-Guide.md) for more details about being a core maintainer.
- Linux maintainers: this team maintains the [`Homebrew/homebrew-core`](https://github.com/Homebrew/homebrew-core) repository on Linux.
- Cask maintainers: this team maintains the [`Homebrew/homebrew-cask`](https://github.com/Homebrew/homebrew-cask) and [`Homebrew/homebrew-cask-fonts`](https://github.com/Homebrew/homebrew-cask-fonts) repositories. See the [Homebrew/homebrew-cask Maintainer Guide](Homebrew-homebrew-cask-Maintainer-Guide.md) for more details about being a cask maintainer.
- Cask maintainers: this team maintains the [`Homebrew/homebrew-cask`](https://github.com/Homebrew/homebrew-cask) repository. See the [Homebrew/homebrew-cask Maintainer Guide](Homebrew-homebrew-cask-Maintainer-Guide.md) for more details about being a cask maintainer.

These documents are meant to serve as guiding principles. As a maintainer, you can make a call to either request changes from a contributor or help them out based on their comfort and previous contributions. Remember, as a team we [Prioritise Maintainers Over Users](Maintainers-Avoiding-Burnout.md) to avoid burnout. If you wish to change or discuss any of the guidelines: open a PR to suggest a change.

Expand Down
7 changes: 3 additions & 4 deletions docs/Manpage.md
Original file line number Diff line number Diff line change
Expand Up @@ -1998,10 +1998,9 @@ Summarise contributions to Homebrew repositories.

: Specify a comma-separated list of repositories to search. Supported
repositories: `brew`, `core`, `cask`, `aliases`, `bundle`,
`command-not-found`, `test-bot`, `services` and `cask-fonts`. Omitting this
flag, or specifying `--repositories=primary`, searches only the main
repositories: brew,core,cask. Specifying `--repositories=all`, searches all
repositories.
`command-not-found`, `test-bot` and `services`. Omitting this flag, or
specifying `--repositories=primary`, searches only the main repositories:
brew,core,cask. Specifying `--repositories=all`, searches all repositories.

`--from`

Expand Down
2 changes: 1 addition & 1 deletion manpages/brew.1
Original file line number Diff line number Diff line change
Expand Up @@ -1265,7 +1265,7 @@ Treat all named arguments as casks\.
Summarise contributions to Homebrew repositories\.
.TP
\fB\-\-repositories\fP
Specify a comma\-separated list of repositories to search\. Supported repositories: \fBbrew\fP, \fBcore\fP, \fBcask\fP, \fBaliases\fP, \fBbundle\fP, \fBcommand\-not\-found\fP, \fBtest\-bot\fP, \fBservices\fP and \fBcask\-fonts\fP\&\. Omitting this flag, or specifying \fB\-\-repositories=primary\fP, searches only the main repositories: brew,core,cask\. Specifying \fB\-\-repositories=all\fP, searches all repositories\.
Specify a comma\-separated list of repositories to search\. Supported repositories: \fBbrew\fP, \fBcore\fP, \fBcask\fP, \fBaliases\fP, \fBbundle\fP, \fBcommand\-not\-found\fP, \fBtest\-bot\fP and \fBservices\fP\&\. Omitting this flag, or specifying \fB\-\-repositories=primary\fP, searches only the main repositories: brew,core,cask\. Specifying \fB\-\-repositories=all\fP, searches all repositories\.
.TP
\fB\-\-from\fP
Date (ISO\-8601 format) to start searching contributions\. Omitting this flag searches the last year\.
Expand Down

0 comments on commit 773dbfa

Please sign in to comment.