d615899ca9
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
16 lines
769 B
Markdown
16 lines
769 B
Markdown
# 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:
|
|
|
|
```json
|
|
{
|
|
"ack": "newack"
|
|
}
|
|
```
|