From 3080c2b209d69ba4da9f828df3243b1df9cbc06d Mon Sep 17 00:00:00 2001 From: Patrick Linnane Date: Thu, 15 Feb 2024 09:26:50 -0800 Subject: [PATCH] docs: `Brew Test Bot` -> `BrewTestBot` Signed-off-by: Patrick Linnane --- docs/Bottles.md | 2 +- docs/{Brew-Test-Bot.md => BrewTestBot.md} | 0 docs/Formula-Cookbook.md | 2 +- docs/Homebrew-homebrew-core-Maintainer-Guide.md | 2 +- docs/README.md | 2 +- 5 files changed, 4 insertions(+), 4 deletions(-) rename docs/{Brew-Test-Bot.md => BrewTestBot.md} (100%) diff --git a/docs/Bottles.md b/docs/Bottles.md index 7283f8e5e1..674b4d7069 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 [Brew Test Bot](Brew-Test-Bot.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, Brew Test Bot 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! diff --git a/docs/Brew-Test-Bot.md b/docs/BrewTestBot.md similarity index 100% rename from docs/Brew-Test-Bot.md rename to docs/BrewTestBot.md diff --git a/docs/Formula-Cookbook.md b/docs/Formula-Cookbook.md index 859da2481d..b763a06105 100644 --- a/docs/Formula-Cookbook.md +++ b/docs/Formula-Cookbook.md @@ -293,7 +293,7 @@ Check the top of the e.g. `./configure` output. Some configure scripts do not re ### Add a test to the formula -Add a valid test to the [`test do`](https://rubydoc.brew.sh/Formula#test-class_method) block of the formula. This will be run by `brew test foo` and [Brew Test Bot](Brew-Test-Bot.md). +Add a valid test to the [`test do`](https://rubydoc.brew.sh/Formula#test-class_method) block of the formula. This will be run by `brew test foo` and [BrewTestBot](BrewTestBot.md). The [`test do`](https://rubydoc.brew.sh/Formula#test-class_method) block automatically creates and changes to a temporary directory which is deleted after run. You can access this [`Pathname`](https://rubydoc.brew.sh/Pathname) with the [`testpath`](https://rubydoc.brew.sh/Formula#testpath-instance_method) function. The environment variable `HOME` is set to [`testpath`](https://rubydoc.brew.sh/Formula#testpath-instance_method) within the [`test do`](https://rubydoc.brew.sh/Formula#test-class_method) block. diff --git a/docs/Homebrew-homebrew-core-Maintainer-Guide.md b/docs/Homebrew-homebrew-core-Maintainer-Guide.md index 0037719037..db3ae67253 100644 --- a/docs/Homebrew-homebrew-core-Maintainer-Guide.md +++ b/docs/Homebrew-homebrew-core-Maintainer-Guide.md @@ -60,7 +60,7 @@ We now accept versioned formulae as long as they [meet the requirements](Version ## Testing -We need to at least check that it builds. Use [Brew Test Bot](Brew-Test-Bot.md) for this. +We need to at least check that it builds. Use [BrewTestBot](BrewTestBot.md) for this. Verify the formula works if possible. If you can’t tell (e.g. if it’s a library) trust the original contributor; it worked for them, so chances are it is fine. If you aren’t an expert in the tool in question, you can’t really gauge if the formula installed the program correctly. At some point an expert will come along, cry blue murder that it doesn’t work, and fix it. This is how open source works. Ideally, request a `test do` block to test that functionality is consistently available. diff --git a/docs/README.md b/docs/README.md index 2c74cb3803..f5efc18b45 100644 --- a/docs/README.md +++ b/docs/README.md @@ -50,7 +50,7 @@ - [Renaming a Formula](Rename-A-Formula.md) - [Building Against Non-Homebrew Dependencies](Building-Against-Non-Homebrew-Dependencies.md) - [How to Create and Maintain a Tap](How-to-Create-and-Maintain-a-Tap.md) -- [Brew Test Bot](Brew-Test-Bot.md) +- [BrewTestBot](BrewTestBot.md) - [Prose Style Guidelines](Prose-Style-Guidelines.md) - [Type Checking with Sorbet](Typechecking.md) - [Reproducible Builds](Reproducible-Builds.md)