mirrors/brew
1
0
Fork 0
mirror of https://github.com/Homebrew/brew.git synced 2025-07-14 07:59:02 +08:00
Code Issues Packages Projects Releases Wiki Activity
brew/docs/Rename-A-Formula.md
Issy Long 31d7bcc583
Add a last_reviewed_date to docs metadata 
- At the AGM we formed an ad-hoc documentation working group.
- One of our ideas was that we should have a last reviewed date for
  documentation, so that we can periodically implement a review
  mechanism (GitHub Actions posts to Slack for a regular documentation
  outdatedness check?) to track how old docs are and ensure they're
  still relevant.
- This is a first step towards that goal, by adding a `last_review_date`
  to the metadata of all docs with a date of earlier than Homebrew's
  inception because everything needs reviewing so that we start from a
  good base!
2025-02-03 11:56:07 +00:00

809 B
Raw Permalink Blame History

last_review_date
last_review_date
1970-01-01

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"
}