aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMike McQuaid2015-04-11 16:46:38 +0100
committerMike McQuaid2015-04-12 21:48:10 -0700
commitef9acd53d7b90a66542a1491ce64661e8216fb33 (patch)
treeaad9e788b5f3e10d442d467fb6f9eef894f8e846
parentdfcb26b2c3a3437e62f934d2c666105e7b15647b (diff)
downloadbrew-ef9acd53d7b90a66542a1491ce64661e8216fb33.tar.bz2
Migrating A Formula To A Tap: add documentation.
Closes Homebrew/homebrew#38570. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
-rw-r--r--share/doc/homebrew/Migrating-A-Formula-To-A-Tap.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/share/doc/homebrew/Migrating-A-Formula-To-A-Tap.md b/share/doc/homebrew/Migrating-A-Formula-To-A-Tap.md
new file mode 100644
index 000000000..c476d5f60
--- /dev/null
+++ b/share/doc/homebrew/Migrating-A-Formula-To-A-Tap.md
@@ -0,0 +1,8 @@
+# Migrating A Formula To A Tap
+There are times when we may wish to migrate a formula from Homebrew's core (the main repository) into a tap (another repository). To do this:
+
+1. Create a pull request to the new tap adding the formula file as-is from the main Homebrew repository. Fix any test failures that may occur due to the stricter requirements for new formulae than existing formula (e.g. `brew audit --strict` must pass for that formula).
+2. Create a pull request to the main repository deleting the formula file and add it to `Library/Homebrew/tap_migrations.rb`.
+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 a tap!