Skip to content

chore: migrate from formula to cask #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AnnatarHe merged 1 commit into from
Jun 22, 2026
Merged

chore: migrate from formula to cask #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 0 additions & 68 deletions Formula/shelltime.rb
View file
Open in desktop

This file was deleted.

6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ Official [Homebrew](https://brew.sh) tap for [ShellTime](https://shelltime.xyz)

## Installation

> [!NOTE]
> The Homebrew tap is distributed as a **macOS-only Cask**. On Linux, install with:
> ```bash
> curl -sSL https://shelltime.xyz/i | bash
> ```
Comment on lines +7 to +11

@gemini-code-assist gemini-code-assist Bot Jun 21, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

Since you are migrating from a formula to a cask, existing macOS users who previously installed shelltime as a formula will not be automatically upgraded to the cask. They will need to uninstall the formula and install the cask.

It would be highly beneficial to include these migration instructions in the note so existing users know how to transition. For example:

> [!NOTE]
> The Homebrew tap is distributed as a **macOS-only Cask**.
> - **On Linux**, install with:
>   ```bash
>   curl -sSL https://shelltime.xyz/i | bash
>   ```
> - **On macOS (existing formula users)**, migrate to the cask by running:
>   ```bash
>   brew uninstall shelltime
>   brew install shelltime
>   ```


```bash
brew tap shelltime/tap
brew install shelltime
Expand Down
3 changes: 3 additions & 0 deletions tap_migrations.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"shelltime": "shelltime"
}
Comment on lines +1 to +3

@gemini-code-assist gemini-code-assist Bot Jun 21, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

high

The tap_migrations.json file should be removed entirely.

  1. Invalid Tap Name: The value "shelltime" is not a valid Homebrew tap name. Homebrew tap names must follow the user/repo format (e.g., shelltime/tap). Using an invalid tap name will cause Homebrew to raise a TapSpecificationError and crash/fail during brew update or brew tap for your users.
  2. Incorrect Usage: tap_migrations.json is designed to redirect formulas/casks that have moved to a different tap (e.g., from homebrew/core to shelltime/tap). It cannot be used to migrate a formula to a cask within the same tap.

Since there is no built-in automatic formula-to-cask migration mechanism in Homebrew for third-party taps, you should delete this file and instead instruct existing users to manually reinstall the package as a cask.