diff options
Diffstat (limited to 'Library/Homebrew/dev-cmd/test-bot.rb')
| -rw-r--r-- | Library/Homebrew/dev-cmd/test-bot.rb | 110 |
1 files changed, 77 insertions, 33 deletions
diff --git a/Library/Homebrew/dev-cmd/test-bot.rb b/Library/Homebrew/dev-cmd/test-bot.rb index a3bd2d4a5..154ac5958 100644 --- a/Library/Homebrew/dev-cmd/test-bot.rb +++ b/Library/Homebrew/dev-cmd/test-bot.rb @@ -1,37 +1,81 @@ -# Comprehensively test a formula or pull request. +#: @hide_from_man_page +#: * `test-bot` [options] <url|formula>: +#: Creates a pull request to boneyard a formula. +#: +#: If `--dry-run` is passed, print what would be done rather than doing +#: it. +#: +#: If `--local` is passed, perform only local operations (i.e. don't +#: push or create PR). +#: +#: If `--keep-logs` is passed, write and keep log files under +#: `./brewbot/`. +#: +#: If `--cleanup` is passed, clean all state from the Homebrew +#: directory. Use with care! +#: +#: If `--clean-cache` is passed, remove all cached downloads. Use with +#: care! +#: +#: If `--skip-setup` is passed, don't check the local system is setup +#: correctly. +#: +#: If `--skip-homebrew` is passed, don't check Homebrew's files and +#: tests are all valid. +#: +#: If `--junit` is passed, generate a JUnit XML test results file. +#: +#: If `--no-bottle` is passed, run `brew install` without +#: `--build-bottle`. +#: +#: If `--keep-old` is passed, run `brew bottle --keep-old` to build new +#: bottles for a single platform. +#: +#: If `--skip-relocation` is passed, run +#: `brew bottle --skip-relocation` to build new bottles that don't +#: require relocation. +#: +#: If `--HEAD` is passed, run `brew install` with `--HEAD`. +#: +#: If `--local` is passed, ask Homebrew to write verbose logs under +#: `./logs/` and set `$HOME` to `./home/`. +#: +#: If `--tap=<tap>` is passed, use the `git` repository of the given +#: tap. +#: +#: If `--dry-run` is passed, just print commands, don't run them. +#: +#: If `--fail-fast` is passed, immediately exit on a failing step. +#: +#: If `--verbose` is passed, print test step output in real time. Has +#: the side effect of passing output as raw bytes instead of +#: re-encoding in UTF-8. +#: +#: If `--fast` is passed, don't install any packages, but run e.g. +#: `brew audit` anyway. +#: +#: If `--keep-tmp` is passed, keep temporary files written by main +#: installs and tests that are run. +#: +#: If `--no-pull` is passed, don't use `brew pull` when possible. +#: +#: If `--coverage` is passed, generate coverage report and send it to +#: Coveralls. +#: +#: If `--ci-master` is passed, use the Homebrew master branch CI +#: options. +#: +#: If `--ci-pr` is passed, use the Homebrew pull request CI options. +#: +#: If `--ci-testing` is passed, use the Homebrew testing CI options. +#: +#: If `--ci-upload` is passed, use the Homebrew CI bottle upload +#: options. +#: # -# Usage: brew test-bot [options...] <pull-request|formula> -# -# Options: -# --keep-logs: Write and keep log files under ./brewbot/. -# --cleanup: Clean the Homebrew directory. Very dangerous. Use with care. -# --clean-cache: Remove all cached downloads. Use with care. -# --skip-setup: Don't check the local system is setup correctly. -# --skip-homebrew: Don't check Homebrew's files and tests are all valid. -# --junit: Generate a JUnit XML test results file. -# --no-bottle: Run brew install without --build-bottle. -# --keep-old: Run brew bottle --keep-old to build new bottles for a single platform. -# --skip-relocation: Run brew bottle --skip-relocation to build new bottles for homebrew/portable. -# --HEAD: Run brew install with --HEAD. -# --local: Ask Homebrew to write verbose logs under ./logs/ and set HOME to ./home/. -# --tap=<tap>: Use the git repository of the given tap. -# --dry-run: Just print commands, don't run them. -# --fail-fast: Immediately exit on a failing step. -# --verbose: Print test step output in realtime. Has the side effect of passing output -# as raw bytes instead of re-encoding in UTF-8. -# --fast: Don't install any packages, but run e.g. audit anyway. -# --keep-tmp: Keep temporary files written by main installs and tests that are run. -# --no-pull: Don't use `brew pull` when possible. -# --coverage: Generate coverage report and send it to Coveralls. -# -# --ci-master: Shortcut for Homebrew master branch CI options. -# --ci-pr: Shortcut for Homebrew pull request CI options. -# --ci-testing: Shortcut for Homebrew testing CI options. -# --ci-upload: Homebrew CI bottle upload. -# -# Influential environment variables include: -# TRAVIS_REPO_SLUG: same as --tap -# GIT_URL: if set to URL of a tap remote, same as --tap +#: Influential environment variables include: +#: `TRAVIS_REPO_SLUG`: same as `--tap` +#: `GIT_URL`: if set to URL of a tap remote, same as `--tap` require "formula" require "utils" |