From 220f56037c447dfbf163e714b3b10885a0affcbd Mon Sep 17 00:00:00 2001 From: Eric Knibbe Date: Thu, 15 Feb 2024 14:50:24 -0500 Subject: [PATCH] docs: redirect from old BrewTestBot URLs Also, sweep up remaining "Brew Test Bot" instances, and use brewtestbot.png for both BrewTestBot pages. --- docs/Bottles.md | 4 ++-- docs/BrewTestBot-For-Maintainers.md | 9 ++++++++- docs/BrewTestBot.md | 4 +++- docs/Formula-Cookbook.md | 4 ++-- docs/Homebrew-and-Python.md | 2 +- docs/Homebrew-homebrew-core-Maintainer-Guide.md | 2 +- 6 files changed, 17 insertions(+), 8 deletions(-) diff --git a/docs/Bottles.md b/docs/Bottles.md index 674b4d70693dd..96106ac596ad4 100644 --- a/docs/Bottles.md +++ b/docs/Bottles.md @@ -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! @@ -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`) diff --git a/docs/BrewTestBot-For-Maintainers.md b/docs/BrewTestBot-For-Maintainers.md index 5249c093699e3..340848f3d9b9e 100644 --- a/docs/BrewTestBot-For-Maintainers.md +++ b/docs/BrewTestBot-For-Maintainers.md @@ -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 diff --git a/docs/BrewTestBot.md b/docs/BrewTestBot.md index 70f7613165078..1a658c32234ad 100644 --- a/docs/BrewTestBot.md +++ b/docs/BrewTestBot.md @@ -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). diff --git a/docs/Formula-Cookbook.md b/docs/Formula-Cookbook.md index b763a061052a8..423d3bbc89a8f 100644 --- a/docs/Formula-Cookbook.md +++ b/docs/Formula-Cookbook.md @@ -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). @@ -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. diff --git a/docs/Homebrew-and-Python.md b/docs/Homebrew-and-Python.md index bc8df9709680d..23de904e308f6 100644 --- a/docs/Homebrew-and-Python.md +++ b/docs/Homebrew-and-Python.md @@ -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? diff --git a/docs/Homebrew-homebrew-core-Maintainer-Guide.md b/docs/Homebrew-homebrew-core-Maintainer-Guide.md index db3ae672538e2..a866180fe7c5d 100644 --- a/docs/Homebrew-homebrew-core-Maintainer-Guide.md +++ b/docs/Homebrew-homebrew-core-Maintainer-Guide.md @@ -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.