From 773dbfa92a2e948503918e3f5cb4769eeb584bee Mon Sep 17 00:00:00 2001 From: Patrick Linnane Date: Wed, 15 May 2024 21:39:13 -0700 Subject: [PATCH] docs: update for Homebrew/cask-fonts deprecation Signed-off-by: Patrick Linnane --- .github/workflows/tests.yml | 15 ++++----------- Library/Homebrew/cask/audit.rb | 2 +- Library/Homebrew/official_taps.rb | 2 +- .../test/cask/cask_loader/from_api_loader_spec.rb | 2 +- completions/fish/brew.fish | 2 +- completions/zsh/_brew | 2 +- docs/Acceptable-Casks.md | 4 ---- docs/Cask-Cookbook.md | 7 ------- docs/Homebrew-homebrew-cask-Maintainer-Guide.md | 7 +------ docs/Maintainer-Guidelines.md | 2 +- docs/Manpage.md | 7 +++---- manpages/brew.1 | 2 +- 12 files changed, 15 insertions(+), 39 deletions(-) diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index 2f849e56dd..a74ce1736c 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -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 @@ -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 @@ -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 diff --git a/Library/Homebrew/cask/audit.rb b/Library/Homebrew/cask/audit.rb index a8a34133c5..a7830286bd 100644 --- a/Library/Homebrew/cask/audit.rb +++ b/Library/Homebrew/cask/audit.rb @@ -197,7 +197,7 @@ module Cask 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 diff --git a/Library/Homebrew/official_taps.rb b/Library/Homebrew/official_taps.rb index e737592650..510c89ad23 100644 --- a/Library/Homebrew/official_taps.rb +++ b/Library/Homebrew/official_taps.rb @@ -3,7 +3,6 @@ OFFICIAL_CASK_TAPS = %w[ cask - cask-fonts ].freeze OFFICIAL_CMD_TAPS = { @@ -19,6 +18,7 @@ DEPRECATED_OFFICIAL_TAPS = %w[ binary cask-drivers cask-eid + cask-fonts cask-versions completions devel-only diff --git a/Library/Homebrew/test/cask/cask_loader/from_api_loader_spec.rb b/Library/Homebrew/test/cask/cask_loader/from_api_loader_spec.rb index d5659638cb..f6c60ff203 100644 --- a/Library/Homebrew/test/cask/cask_loader/from_api_loader_spec.rb +++ b/Library/Homebrew/test/cask/cask_loader/from_api_loader_spec.rb @@ -42,7 +42,7 @@ RSpec.describe Cask::CaskLoader::FromAPILoader, :cask do 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 diff --git a/completions/fish/brew.fish b/completions/fish/brew.fish index e261de07e1..7fd71e9fe0 100644 --- a/completions/fish/brew.fish +++ b/completions/fish/brew.fish @@ -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' diff --git a/completions/zsh/_brew b/completions/zsh/_brew index 174cffe167..5a2dd129bf 100644 --- a/completions/zsh/_brew +++ b/completions/zsh/_brew @@ -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]' diff --git a/docs/Acceptable-Casks.md b/docs/Acceptable-Casks.md index 6b9f712335..6de1de69da 100644 --- a/docs/Acceptable-Casks.md +++ b/docs/Acceptable-Casks.md @@ -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—what is useful to one user may be seen as malicious by another. diff --git a/docs/Cask-Cookbook.md b/docs/Cask-Cookbook.md index a90c6bb01d..ff9784afb1 100644 --- a/docs/Cask-Cookbook.md +++ b/docs/Cask-Cookbook.md @@ -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 @@ -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. diff --git a/docs/Homebrew-homebrew-cask-Maintainer-Guide.md b/docs/Homebrew-homebrew-cask-Maintainer-Guide.md index 68974a02f0..5ba68447cb 100644 --- a/docs/Homebrew-homebrew-cask-Maintainer-Guide.md +++ b/docs/Homebrew-homebrew-cask-Maintainer-Guide.md @@ -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 diff --git a/docs/Maintainer-Guidelines.md b/docs/Maintainer-Guidelines.md index 76cb1cf7d4..024ab1e05b 100644 --- a/docs/Maintainer-Guidelines.md +++ b/docs/Maintainer-Guidelines.md @@ -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. diff --git a/docs/Manpage.md b/docs/Manpage.md index b01e1b8021..fc62d4e58f 100644 --- a/docs/Manpage.md +++ b/docs/Manpage.md @@ -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` diff --git a/manpages/brew.1 b/manpages/brew.1 index bb93951de1..673a07c724 100644 --- a/manpages/brew.1 +++ b/manpages/brew.1 @@ -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\.