Skip to content

cask/ci/check: ignore more running Apple apps - #24244

Merged
bevanjkay merged 1 commit into
mainfrom
cask_ci_ignore_apple_apps
Oct 13, 2026
Merged

bevanjkay merged 1 commit into
mainfrom
cask_ci_ignore_apple_apps

Conversation

@bevanjkay

Copy link
Copy Markdown
Member
  • Some casks open an Apple app on install or first launch, e.g. typinator opens its tutorial .rtfd in TextEdit, which fails CI with com.apple.TextEdit left running.
  • Casks have worked around this with uninstall quit: stanzas for Help Viewer (eaglefiler), Mail (gpg-suite*, mailsteward) and Music (quakenotch). But system apps should not be quit during uninstall.
  • A cask shouldn't quit a system app, so treat these like the other Apple apps already in APPLE_LAUNCHJOBS_REGEX.

  • Have you followed our Contributing guidelines?
  • Have you checked for other open Pull Requests for the same change?
  • Have you explained what your changes do? Performance claims (e.g. "this is faster") must include brew benchmark results.
  • Have you explained why you'd like these changes included, not just what they do?
  • For bug fixes, have you given step-by-step brew commands to reproduce the bug?
  • Have you written new tests (excluding integration tests)? Here's an example.
  • Have you successfully run brew lgtm (style, typechecking and tests) locally?

  • I did not use AI/LLM to create this PR, or I disclosed the tool/model below and reviewed its output; I did not attribute commits to AI and will answer maintainer questions and review comments myself without AI/LLM.

Claude with Opus 5.5 at High effort, with local review and testing.


- Some casks open an Apple app on install or first launch, e.g.
  `typinator` opens its tutorial `.rtfd` in TextEdit, which fails CI
  with `com.apple.TextEdit` left running.
- Casks have worked around this with `uninstall quit:` stanzas for
  Help Viewer (`eaglefiler`), Mail (`gpg-suite*`, `mailsteward`) and
  Music (`quakenotch`), which quit the user's app on uninstall and
  risk losing their work.
- A cask shouldn't quit a system app, so treat these like the other
  Apple apps already in `APPLE_LAUNCHJOBS_REGEX`.
@coderabbitai

coderabbitai Bot commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

📝 Summary

Summary by CodeRabbit

  • Bug Fixes
    • Apple Help Viewer, Mail, Music, System Events, and System Preferences launch jobs are now correctly excluded from launch-job checks.

The Apple launch-job regex now matches additional Apple job names. The test input includes additional known-running job identifiers.

Changes: Apple launch-job matching

Layer / File(s) Summary
Expand Apple launch-job matching
Library/Homebrew/cask/ci/check.rb, Library/Homebrew/test/cask/ci/check_spec.rb
The regex adds helpviewer, mail, Music, systemevents, and systempreferences. The test adds Help Viewer, Mail, Music, and TextEdit identifiers to the known-running jobs.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~5 minutes

Change: Bug fix

Merge Risk: 🔵 Low · up to 773cb

Two new Apple job-name exclusions lack regression coverage, so a future regression could bring back CI errors when those jobs remain running. This is a small, bounded test follow-up; the change is otherwise mergeable.

Pre-merge checks · Passed 4
Passed Passed checks (4 passed)
Check name Status Explanation
Title check Passed The title clearly and concisely describes the main change: updating cask CI checks to ignore additional running Apple apps.
Description check Passed The description directly explains the affected Apple apps, the CI failure scenario, the reason system apps should not be quit during uninstall, and the implemented solution.
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
Library/Homebrew/test/cask/ci/check_spec.rb (1)

44-51: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Cover systemevents and systempreferences in the fixture.

The current fixture does not exercise these two existing APPLE_LAUNCHJOBS_REGEX alternatives. Add both identifiers so removing either alternative causes this assertion to fail.

Suggested fix
         "application.com.apple.Safari.123",
+        "application.com.apple.systemevents.123",
+        "application.com.apple.systempreferences.123",
         "application.com.apple.TextEdit.123",

ℹ️ Review info
⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 98dd16c4-cbd6-4a73-b473-51158dfef91a
📥 Commits

Reviewing files that changed from the base of the PR and between 1220a4a and 773cb7c.

📒 Files selected for processing (2)
  • Library/Homebrew/cask/ci/check.rb
  • Library/Homebrew/test/cask/ci/check_spec.rb

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 9 remain after this review.

📜 Review details
⏰ Context from checks skipped due to timeout. (19)
  • GitHub Check: docker (x86_64 Ubuntu 26.04)
  • GitHub Check: docker (x86_64 Ubuntu 24.04)
  • GitHub Check: docker (arm64 Ubuntu 24.04)
  • GitHub Check: docker (arm64 Ubuntu 26.04)
  • GitHub Check: workflow_syntax
  • GitHub Check: tests (macOS, 2/2)
  • GitHub Check: tests (generic OS, 1/2)
  • GitHub Check: tests (online, 2/2)
  • GitHub Check: tests (load-only macOS)
  • GitHub Check: tests (macOS, 1/2)
  • GitHub Check: tests (no Sorbet)
  • GitHub Check: tests (generic OS, 2/2)
  • GitHub Check: tests (load-only Linux)
  • GitHub Check: tests (Linux, 2/2)
  • GitHub Check: tests (online, 1/2)
  • GitHub Check: tests (Linux, 1/2)
  • GitHub Check: docs
  • GitHub Check: syntax
  • GitHub Check: Analyze
🔇 Additional comments (2)
Library/Homebrew/cask/ci/check.rb (1)

18-19: LGTM!

Library/Homebrew/test/cask/ci/check_spec.rb (1)

44-51: LGTM!

@MikeMcQuaid MikeMcQuaid left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@krehel

krehel commented Oct 13, 2026

Copy link
Copy Markdown
Member

Good idea!

@bevanjkay
bevanjkay added this pull request to the merge queue Oct 13, 2026
Merged via the queue into main with commit 3c1f920 Oct 13, 2026
53 checks passed
@bevanjkay
bevanjkay deleted the cask_ci_ignore_apple_apps branch October 13, 2026 23:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

⌂ 换网址