Skip to content

Commit

Permalink
Merge pull request #16670 from EricFromCanada/BrewTestBot-URLs
Browse files Browse the repository at this point in the history
docs: redirect from old BrewTestBot URLs
  • Loading branch information
p-linnane authored Feb 15, 2024
2 parents 0a206a4 + 220f560 commit 65102db
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 8 deletions.
4 changes: 2 additions & 2 deletions docs/Bottles.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Bottles will not be used if:

## Creation

Bottles for `homebrew/core` formulae are created by [BrewTestBot](BrewTestBot.md) when a pull request is submitted. If the formula builds successfully on each supported platform and a maintainer approves the change, Brew Test Bot updates its `bottle do` block and uploads each bottle to [GitHub Packages](https://github.com/orgs/Homebrew/packages).
Bottles for `homebrew/core` formulae are created by [BrewTestBot](BrewTestBot.md) when a pull request is submitted. If the formula builds successfully on each supported platform and a maintainer approves the change, BrewTestBot updates its `bottle do` block and uploads each bottle to [GitHub Packages](https://github.com/orgs/Homebrew/packages).

By default, bottles will be built for the oldest CPU supported by the OS/architecture you're building for (Core 2 for 64-bit x86 operating systems). This ensures that bottles are compatible with all computers you might distribute them to. If you *really* want your bottles to be optimised for something else, you can pass the `--bottle-arch=` option to build for another architecture; for example, `brew install foo --build-bottle --bottle-arch=penryn`. Just remember that if you build for a newer architecture, some of your users might get binaries they can't run and that would be sad!

Expand Down Expand Up @@ -62,7 +62,7 @@ By default this is omitted and Homebrew's default bottle URL root is used. This

Optionally contains the value of `HOMEBREW_CELLAR` in which the bottles were built.

Most compiled software contains references to its compiled location, preventing it from being simply relocated anywhere on disk. A value of `:any` or `:any_skip_relocation` means that the bottle can be safely installed in any Cellar as it did not contain any references to the Cellar in which it was originally built. This can be omitted if the bottle was compiled for the given OS/architecture's default `HOMEBREW_CELLAR`, as is done for all bottles built by Brew Test Bot.
Most compiled software contains references to its compiled location, preventing it from being simply relocated anywhere on disk. A value of `:any` or `:any_skip_relocation` means that the bottle can be safely installed in any Cellar as it did not contain any references to the Cellar in which it was originally built. This can be omitted if the bottle was compiled for the given OS/architecture's default `HOMEBREW_CELLAR`, as is done for all bottles built by BrewTestBot.

### Rebuild version (`rebuild`)

Expand Down
9 changes: 8 additions & 1 deletion docs/BrewTestBot-For-Maintainers.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
---
logo: /assets/img/brewtestbot.png
image: /assets/img/brewtestbot.png
redirect_from:
- /Brew-Test-Bot-For-Core-Contributors
---

# BrewTestBot for Maintainers

`brew test-bot` is the command our CI runs to test and build bottles for formulae.
[`brew test-bot`](Manpage.md#test-bot-options-formula) is the command our [CI](https://github.com/BrewTestBot) runs to test and build bottles for formulae.

## Publishing Bottles

Expand Down
4 changes: 3 additions & 1 deletion docs/BrewTestBot.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
---
logo: /assets/img/brewtestbot.png
image: /assets/img/brewtestbot.png
redirect_from:
- /Brew-Test-Bot
---

# Brew Test Bot
# BrewTestBot

[`brew test-bot`](Manpage.md#test-bot-options-formula) is what runs the automated review and testing system funded by [our Kickstarter in 2013](https://www.kickstarter.com/projects/homebrew/brew-test-bot).

Expand Down
4 changes: 2 additions & 2 deletions docs/Formula-Cookbook.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ There are plenty of others; check `/usr/lib` for them.

We generally try not to duplicate system libraries and complicated tools in core Homebrew but we do duplicate some commonly used tools.

Special exceptions are OpenSSL and LibreSSL. Things that use either *should* be built using Homebrew’s shipped equivalent and our Brew Test Bot's post-install `audit` will warn if it detects you haven't done this.
Special exceptions are OpenSSL and LibreSSL. Things that use either *should* be built using Homebrew’s shipped equivalent and our BrewTestBot's post-install `audit` will warn if it detects you haven't done this.

**Important:** `$(brew --prefix)/bin` is NOT in the `PATH` during formula installation. If you have dependencies at build time, you must specify them and `brew` will add them to the `PATH` or create a [`Requirement`](https://rubydoc.brew.sh/Requirement).

Expand Down Expand Up @@ -377,7 +377,7 @@ Add aliases by creating symlinks in an `Aliases` directory in the tap root.

You can run `brew audit --strict --online` to test formulae for adherence to Homebrew house style, which is loosely based on the [Ruby Style Guide](https://github.com/rubocop-hq/ruby-style-guide#the-ruby-style-guide). The `audit` command includes warnings for trailing whitespace, preferred URLs for certain source hosts, and many other style issues. Fixing these warnings before committing will make the process a lot quicker for everyone.

New formulae being submitted to Homebrew should run `brew audit --new --formula foo`. This command is performed by Brew Test Bot on new submissions as part of the automated build and test process, and highlights more potential issues than the standard audit.
New formulae being submitted to Homebrew should run `brew audit --new --formula foo`. This command is performed by BrewTestBot on new submissions as part of the automated build and test process, and highlights more potential issues than the standard audit.

Use `brew info` and check if the version guessed by Homebrew from the URL is correct. Add an explicit [`version`](https://rubydoc.brew.sh/Formula#version-class_method) if not.

Expand Down
2 changes: 1 addition & 1 deletion docs/Homebrew-and-Python.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ If you wish to install a non-brew-packaged Python package (from PyPI for example
You can install `pipx` by running `brew install pipx`.
When you use `pipx` to install a Python application, it will always use a virtual environment for you.

It is possible to install some Python packages as formulae, by using `brew install xyz`. We do not recommend using these formulae and recommend you install them with pip using a virtualenv. These syste-wide Hombrew Python formulae are often Homebrew-specific formulae that are useful as dependencies for other Homebrew formulae. It is not recommended to rely on them.
It is possible to install some Python packages as formulae by using `brew install xyz`. We do not recommend using these formulae and instead recommend you install them with pip inside a virtualenv. These system-wide Homebrew Python formulae are often Homebrew-specific formulae that are useful as dependencies for other Homebrew formulae. It is not recommended to rely on them.

## Why is Homebrew's Python being installed as a dependency?

Expand Down
2 changes: 1 addition & 1 deletion docs/Homebrew-homebrew-core-Maintainer-Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A detailed checklist can be found [below](#detailed-merge-checklist). This is al
- Ensure it is not a library that can be installed with [gem](https://en.wikipedia.org/wiki/RubyGems), [cpan](https://en.wikipedia.org/wiki/Cpan) or [pip](https://pip.pypa.io/en/stable/).
- Ensure that any dependencies are accurate and minimal. We don't need to support every possible optional feature for the software.
- When bottles aren't required or affected, use the GitHub squash & merge workflow for a single-formula PR or rebase & merge workflow for a multiple-formulae PR. See the [How to merge without bottles](#how-to-merge-without-bottles) section below for more details.
- Use `brew pr-publish` or `brew pr-pull` otherwise, which adds messages to auto-close pull requests and pull bottles built by Brew Test Bot.
- Use `brew pr-publish` or `brew pr-pull` otherwise, which adds messages to auto-close pull requests and pull bottles built by BrewTestBot.
- Thank people for contributing.

Checking dependencies is important, because they will probably stick around forever. Nobody really checks if they are necessary or not.
Expand Down

0 comments on commit 65102db

Please sign in to comment.