shen/brew
1
0
Fork 0
mirror of https://github.com/Homebrew/brew.git synced 2024-11-25 16:33:34 +08:00
Code Issues Actions 11 Packages Projects Releases Wiki Activity
master
brew/docs/Rename-A-Formula.md
EricFromCanada d615899ca9
Contributors docs: content & formatting updates 
Update How-To-Open-a-Homebrew-Pull-Request.md

Update Acceptable-Formulae.md

Update Acceptable-Casks.md

Update License-Guidelines.md

Update Versions.md

Update Versions.md

Update Deprecating-Disabling-and-Removing-Formulae.md

Update Node-for-Formula-Authors.md

Update Python-for-Formula-Authors.md

Update Brew-Livecheck.md

Update Migrating-A-Formula-To-A-Tap.md

Update Rename-A-Formula.md

Update How-to-Create-and-Maintain-a-Tap.md

Update Brew-Test-Bot.md

Update Typechecking.md
2022-11-16 09:03:12 -05:00

769 B
Raw Permalink 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 name. 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 compared to existing formulae (e.g. brew audit --strict must pass for that formula).

  2. Create a pull request on 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"
}