brew/docs/Migrating-A-Formula-To-A-Tap.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

995 B

last_review_date
last_review_date
1970-01-01

Migrating a Formula to a Tap

There are times when we may wish to migrate a formula from one tap into another tap. To do this:

  1. Create a pull request on the new tap adding the formula file as-is from the original tap. 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 original tap deleting the formula file and adding it to tap_migrations.json with a commit message like gv: migrate to homebrew/core.
  3. Put a link for each pull request in the other pull request so the maintainers can merge them both at once.

Congratulations, you've moved a formula to another tap!

For Homebrew maintainers, formulae should only ever be migrated into and within the Homebrew organisation (e.g. from homebrew/core to homebrew/cask, or from a third-party tap to homebrew/core), and never out of it.