admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity
brew/Library/Homebrew
History
Issy Long 7605924232
When a HEAD build fails, output an instruction to raise PRs not issues 
- This has to be in multiple places, hence a new method. A patch failing
  to apply, which is a common occurrence with HEAD builds because the
  patch is already upstream, raises a different exception to another,
  "normal" build failure.

Tested with:

```
╭─issyl0@rigel /home/linuxbrew/.linuxbrew/Homebrew ‹head-builds-arent-officially-supported*›
╰─ $ brew install --HEAD mtr
==> Cloning https://github.com/traviscross/mtr.git
Updating /home/issyl0/.cache/Homebrew/mtr--git
==> Checking out branch master
Already on 'master'
Your branch is up to date with 'origin/master'.
HEAD is now at 155f76a Merge pull request #340 from Sea-n/master
==> Downloading https://github.com/traviscross/mtr/pull/315.patch?full_index=1
Already downloaded: /home/issyl0/.cache/Homebrew/downloads/82d9d939303d8fceb7a3ae071ecd49a5f075e0fb451b308653b555ffbae74336--315.patch
==> Patching
==> Applying 315.patch
patching file packet/probe.c
Hunk #1 FAILED at 323.
Hunk #2 FAILED at 364.
2 out of 2 hunks FAILED -- saving rejects to file packet/probe.c.rej
Error: Failure while executing; `patch -g 0 -f -p1 -i /tmp/mtr--patch-20200330-10734-avjmyy/315.patch` exited with 1.
HEAD builds are unsupported by maintainers - please file pull requests instead of issues.
```

and

```
╭─issyl0@rigel /home/linuxbrew/.linuxbrew/Homebrew ‹head-builds-arent-officially-supported*›
╰─ $ brew install --HEAD zookeeper
==> Cloning https://gitbox.apache.org/repos/asf/zookeeper.git
Updating /home/issyl0/.cache/Homebrew/zookeeper--git
==> Checking out branch master
Already on 'master'
Your branch is up to date with 'origin/master'.
HEAD is now at 1ff1b779 ZOOKEEPER-3755: Use maven to create fatjar
==> ant compile_jute
Last 15 lines from /home/issyl0/.cache/Homebrew/Logs/zookeeper/01.ant:
2020-03-30 21:45:10 +0100

ant
compile_jute

Picked up _JAVA_OPTIONS: -Duser.home=/home/issyl0/.cache/Homebrew/java_cache
Buildfile: build.xml does not exist!
Build failed

READ THIS: https://docs.brew.sh/Troubleshooting

HEAD builds are unsupported by maintainers - please file pull requests instead of issues.
```
2020-03-31 14:49:02 +01:00
..
.bundle
…
cask
cask-caveats-kext: retry installation if it fails
2020-03-23 16:13:50 +00:00
cli
Merge pull request #7238 from Homebrew/dependabot/bundler/Library/Homebrew/unf_ext-0.0.7.7
2020-03-29 19:36:51 +01:00
cmd
cmd/update-report: check for HOMEBREW_DISABLE_LOAD_FORMULA
2020-03-28 22:15:07 +00:00
compat
language/python: move rewrite_python_shebang to compat
2020-03-27 22:27:06 +00:00
debrew
…
dev-cmd
pr-pull: update for gpg environment and secrets
2020-03-31 22:11:30 +11:00
extend
Merge pull request #7238 from Homebrew/dependabot/bundler/Library/Homebrew/unf_ext-0.0.7.7
2020-03-29 19:36:51 +01:00
language
language/python: move rewrite_python_shebang to compat
2020-03-27 22:27:06 +00:00
manpages
Use long --disable instead of short -q in curl
2020-03-29 20:04:37 +01:00
os
os/mac/xcode: support Xcode 11.4
2020-03-26 22:03:54 +00:00
requirements
rubocop: apply autofixes.
2020-03-13 21:16:18 +00:00
rubocops
rubocops/patches: suggest url with full_index=1
2020-03-15 11:24:38 +00:00
shims
…
test
Merge pull request #7225 from bayandin/add-free-port
2020-03-31 09:06:04 +01:00
unpack_strategy
…
utils
utils/github: properly use token scopes
2020-03-31 22:11:06 +11:00
vendor
brew vendor-gems: commit updates.
2020-03-20 11:40:12 +00:00
version
…
.rubocop.yml
rubocop: enable Style/TrailingBodyOnMethodDefinition.
2020-03-14 19:46:23 +00:00
.simplecov
…
bintray.rb
bintray: only clear Bintray key
2020-03-31 22:11:06 +11:00
bottle_publisher.rb
…
brew.rb
When a HEAD build fails, output an instruction to raise PRs not issues
2020-03-31 14:49:02 +01:00
brew.sh
brew.sh: obey HOMEBREW_COLOR
2020-03-31 00:17:42 +02:00
build_environment.rb
…
build_options.rb
…
build.rb
Merge pull request #7176 from GauthamGoli/argv-cleanup-14
2020-03-16 13:02:42 +00:00
cache_store.rb
…
caveats.rb
…
checksum.rb
…
cleaner.rb
ARGV: Replace ARGV.verbose? with Homebrew.args.verbose?
2020-02-02 14:00:04 +01:00
cleanup.rb
cleanup: fix portable ruby bundler removal logic.
2020-01-16 16:06:22 +00:00
commands.rb
commands: helper for official external commands.
2020-03-11 12:17:25 +00:00
compat.rb
language/python: move rewrite_python_shebang to compat
2020-03-27 22:27:06 +00:00
compilers.rb
…
config.rb
…
cxxstdlib.rb
…
debrew.rb
…
dependable.rb
…
dependencies.rb
deps: don't skip those that are both :build and :test
2019-12-27 17:35:18 -05:00
dependency_collector.rb
dependency_collector: make resource dep available at test-time too
2020-03-04 22:49:54 +01:00
dependency.rb
Rename Formula#installed? to Formula#latest_version_installed?
2019-12-03 11:42:42 +00:00
description_cache_store.rb
…
descriptions.rb
…
development_tools.rb
…
diagnostic.rb
diagnostic: check homebrew-core git status.
2020-03-11 17:25:07 +00:00
download_strategy.rb
ARGV: Replace ARGV.verbose? with Homebrew.args.verbose?
2020-02-02 14:00:04 +01:00
emoji.rb
…
exceptions.rb
exceptions: fix case for UsageError subclasses.
2020-03-05 09:25:14 +00:00
fetch.rb
…
formula_assertions.rb
formula_assertions: print output on assertion failed.
2020-03-10 09:21:30 +00:00
formula_cellar_checks.rb
Remove 'run' from generic binaries list
2019-12-22 08:52:47 +01:00
formula_creator.rb
create: add --ruby option
2020-03-21 15:41:27 +01:00
formula_free_port.rb
Library/Homebrew: add free_port test helper
2020-03-31 00:00:11 +01:00
formula_info.rb
…
formula_installer.rb
ARGV: Deprecate ARGV.collect_build_args
2020-03-28 21:00:59 +05:30
formula_pin.rb
…
formula_support.rb
…
formula_versions.rb
Format debug messages with odebug
2019-12-02 11:33:19 -05:00
formula.rb
utils/shebang: add rewrite_shebang
2020-03-27 13:04:39 +00:00
formulary.rb
formulary: fix typo.
2020-03-11 13:12:49 +00:00
Gemfile
…
Gemfile.lock
build: bump unf_ext from 0.0.7.6 to 0.0.7.7 in /Library/Homebrew
2020-03-29 17:14:30 +00:00
global.rb
Move more command handling logic to commands.rb.
2020-02-02 17:05:45 +01:00
hardware.rb
…
help.rb
Move more command handling logic to commands.rb.
2020-02-02 17:05:45 +01:00
install_renamed.rb
…
install.rb
…
keg_relocate.rb
…
keg.rb
keg: handle more exceptions on uninstall.
2020-03-04 14:17:08 +00:00
lazy_object.rb
…
linkage_cache_store.rb
…
linkage_checker.rb
Autofix rubocop checks.
2020-02-19 11:24:12 +00:00
load_path.rb
…
locale.rb
…
lock_file.rb
…
messages.rb
…
metafiles.rb
…
migrator.rb
ARGV: Replaces usages of ARGV.force? with Homebrew.args.force?
2020-01-15 21:09:31 +05:30
missing_formula.rb
missing_formula: TexLive is only blacklisted on macOS
2020-02-15 19:51:48 +00:00
mktemp.rb
…
official_taps.rb
…
options.rb
…
os.rb
…
patch.rb
rubocop: apply autofixes.
2020-03-13 21:16:18 +00:00
PATH.rb
…
pkg_version.rb
pkg_version: tweak variable naming.
2020-03-04 11:28:28 +00:00
postinstall.rb
postinstall: use arguments from main command.
2020-01-13 14:57:15 +00:00
readall.rb
…
README.md
…
reinstall.rb
ARGV: Deprecate ARGV.git?
2020-03-15 18:32:21 +05:30
requirement.rb
…
requirements.rb
…
resource.rb
patch: add support for changing directory
2020-03-09 19:51:10 +00:00
rubocops.rb
…
sandbox.rb
ARGV: Replace ARGV.verbose? with Homebrew.args.verbose?
2020-02-02 14:00:04 +01:00
search.rb
…
searchable.rb
…
software_spec.rb
uses_from_macos: remove before/after.
2019-12-19 14:36:33 +00:00
style.rb
rubocop: apply autofixes.
2020-03-13 21:16:18 +00:00
system_command.rb
ARGV: Replace ARGV.verbose? with Homebrew.args.verbose?
2020-02-02 14:00:04 +01:00
system_config.rb
system_config: ignore HOMEBREW_*_GIT_REMOTE.
2020-01-18 14:25:38 +00:00
tab.rb
rubocop: apply autofixes.
2020-03-13 21:16:18 +00:00
tap_constants.rb
…
tap.rb
tap-info: drop commands' brew(cask) naming requirement
2020-02-21 11:15:17 -05:00
test.rb
Library/Homebrew: add free_port test helper
2020-03-31 00:00:11 +01:00
unpack_strategy.rb
…
utils.rb
Clarify tap issues should not be reported to Homebrew.
2020-03-11 10:57:36 +00:00
version.rb
version: handle -stable in tag
2020-02-28 14:57:28 -05:00

README.md

Homebrew's Formula API

This is the public API for Homebrew.

The main class you should look at is the {Formula} class (and classes linked from there). That's the class that's used to create Homebrew formulae (i.e. package descriptions). Assume anything else you stumble upon is private.

You may also find the Formula Cookbook and Ruby Style Guide helpful in creating formulae.

Good luck!