docs/Cask-Cookbook: align with homebrew-cask standards - #23842
Merged
Conversation
bevanjkay
force-pushed
the
cask_review_homebrew
branch
from
September 6, 2026 10:21
2ed9c2e to
663241c
Compare
Contributor
There was a problem hiding this comment.
馃煛 Changes recommended
Correct the overstated audit guidance and resolve the identified semantic-line-break issues.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Updates the Cask Cookbook to reflect current Homebrew Cask standards and behavior.
Changes:
- Clarifies Cask authoring, uninstall, dependency, and checksum guidance.
- Removes obsolete OSDN documentation.
- Updates SourceForge references and Vale exceptions.
File summaries
| File | Description |
|---|---|
Library/Homebrew/cask/audit.rb |
Updates the SourceForge documentation link. |
docs/vale-styles/Homebrew/Headings.yml |
Removes the obsolete OSDN exception. |
docs/Cask-Cookbook.md |
Modernizes Cask authoring guidance and examples. |
Review details
Suppressed comments (2)
docs/Cask-Cookbook.md:450
- This changed paragraph puts two sentences on one source line, contrary to the semantic-line-break rule in
docs/AGENTS.md:20. Split them into separate lines.
An array of symbols is accepted when a cask must run on one of an exact set of macOS releases. The array must list two or more releases; a single-element array means the same thing as the bare symbol, i.e. a minimum:
docs/Cask-Cookbook.md:1379
- The example introduction is a second sentence on the same source line.
docs/AGENTS.md:20requires semantic line breaks, so move it to its own line.
A cask that varies by both takes a `sha256` for each supported combination. Example (from [1password-cli.rb](https://github.com/Homebrew/homebrew-cask/blob/e04021c857906ba15366b622c8b35957b9aef13c/Casks/1/1password-cli.rb#L1-L11)):
- Files reviewed: 3/3 changed files
- Comments generated: 4
- Review effort level: Balanced
馃挕 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.
MikeMcQuaid
approved these changes
Sep 6, 2026
MikeMcQuaid
left a comment
MikeMcQuaid
left a comment
Member
There was a problem hiding this comment.
Thanks! Good to address Copilot rules but otherwise great.
- `depends_on macos:`: drop the `">= :big_sur"` and `"== :big_sur"` forms, deprecated by `MacOSRequirement.parse` and unused in homebrew/cask. An exact set needs two or more symbols, as a one-element array is parsed as a minimum. - Stanza parameters: drop the claim that they are alphabetical, which is untrue of `uninstall`, `zap` and `sha256`. - `uninstall`: reword the note on directive order. - OSDN: `audit_download_url_is_osdn` rejects any `osdn.jp` host, so drop the OSDN URL format and narrow the section, the audit error linked to it and the headings vale style to SourceForge. - Replace the `appium-desktop` cask, since removed, with `unison-app` as the example of the `-app` suffix rule. - Document `launchctl:` wildcards and the `os` stanza, the latter alongside `arch`, which it mirrors. - Document that the minimum macOS release comes from the artifact and Sparkle feed rather than vendor documentation, per `audit_min_os`.
bevanjkay
force-pushed
the
cask_review_homebrew
branch
from
September 6, 2026 11:47
663241c to
55efd1f
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR updates the Cask Cookbook documentation to meet the current expectations and prevailing standards in the
homebrew-caskrepository.brew benchmarkresults.brewcommands to reproduce the bug?brew lgtm(style, typechecking and tests) locally?I used
claude-codewith Opus 5 to audit where the documentation had become stale against the standards, verified and modified the changes myself.