mirrors/brew
1
0
Fork 0
mirror of https://github.com/Homebrew/brew.git synced 2025-07-14 16:09:03 +08:00
Code Issues Packages Projects Releases Wiki Activity
brew/docs/Rename-A-Formula.md
Dawid Wróbel 2c89e2a762
brew audit --strict is not enough 
brew audit --strict does not catch all the issues. The CI/CD uses "brew audit --online --new-formula" and is more thorough, catching e.g. "New formulae in homebrew/core should not have a 'bottle do'" which brew audit --strict does not.
2021-03-18 20:48:25 -04:00

771 B
Raw Blame History

Renaming a Formula

Sometimes software and formulae need to be renamed. To rename a formula you need to:

  1. Rename the formula file and its class to a new formula. The new name must meet all the usual rules of formula naming. Fix any test failures that may occur due to the stricter requirements for new formulae than existing formulae (i.e. brew audit --online --new-formula must pass for that formula).

  2. Create a pull request to the corresponding tap deleting the old formula file, adding the new formula file, and adding it to formula_renames.json with a commit message like newack: renamed from ack. Use the canonical name (e.g. ack instead of user/repo/ack).

A formula_renames.json example for a formula rename:

{
  "ack": "newack"
}