如何在 GitHub 上创建 Homebrew tap

已编辑 1 天前 通过 ExtremeHow 编辑团队

自酿软件GitHub代码托管平台自定义选项卡软件开发开源终端命令行软件包管理编程协作

Homebrew 是一个流行的 macOS（和 Linux）程序包管理器，可帮助用户轻松安装 Apple 或系统默认情况下不提供的软件。它通过管理软件包及其依赖项的安装来工作。 “Tap” 是 Homebrew 配方的附加存储库。这些公式是描述如何安装特定软件包的脚本。在 GitHub 上创建 Homebrew tap 可让您轻松地将软件分发给用户。在这里，我们将逐步完成在 GitHub 上创建自己的 Homebrew tap 的详细步骤。

先决条件

在构建 homebrew tap 之前有一些先决条件：

• GitHub 帐户：您需要一个 GitHub 帐户来托管您的 tap。
• 您的系统上已安装 Homebrew：本指南假定您已在计算机上安装并配置了 Homebrew。如果没有，请访问Homebrew 网站安装它。
• 基本的 Git 和 GitHub 知识：您应该熟悉存储库、克隆和基本的 git 命令。

步骤 1：创建 GitHub 存储库

第一步是创建一个新的 GitHub 存储库。该存储库将作为您公式的家。按照以下步骤操作：

1. 登录您的 GitHub 帐户并转到存储库页面。
2. 单击“新建”按钮以创建一个新存储库。
3. 以此格式命名您的存储库：homebrew-<name>。例如， 如果你为名为“awesome-tool”的项目创建一个 tap，你可以将存储库命名为 homebrew-awesome-tool。
4. 为您的存储库添加描述（可选，但推荐）。
5. 不要使用 README、.gitignore 或许可证初始化存储库，因为这些文件将在以后添加。
6. 点击“创建存储库”按钮。

步骤 2：在本地克隆存储库

创建存储库后，您需要将其克隆到本地计算机以开始添加公式文件。 方法如下：

1. 从 GitHub 复制存储库 URL。通过单击新创建的存储库中的“代码”按钮可以获得此 URL。
2. 打开你的终端。
3. 使用 git clone 命令将存储库克隆到本地计算机：

git clone https://github.com/<username>/homebrew-<name>.git

4. 导航到克隆的存储库目录：

cd homebrew -p <name>

步骤 3：创建公式文件

现在是时候创建一个公式文件了。 该文件包含有关 Homebrew 如何安装您的软件的所有信息。 按照以下步骤操作：

1. 在本地存储库的根目录下创建一个名为 Formula 的新目录。 这是所有公式文件的存放位置：

mkdir Formula

2. 导航到 Formula 目录：

cd Formula

3. 为公式创建一个新的 Ruby 文件。文件名应为您的软件名称，并带有 .rb 扩展名。 例如，为“awesome-tool”创建 awesome-tool.rb：

touch awesome-tool.rb

步骤 4：编写公式

接下来，编辑公式文件并添加必要的 Ruby 代码以确定如何安装您的软件。 以下是 awesome-tool.rb 中可能的简单示例：

class AwesomeTool < Formula
    desc "Amazing tool is a great utility for amazing things"
    homepage "https://example.com/awesome-tool"
    url "https://example.com/awesome-tool-v1.0.tar.gz"
    sha256 "examplechecksumvaluehere1234567890abcdef"
    version "1.0"

    def install
        bin.install "awesome-tool"
    end
end

代码说明：

• class AwesomeTool < Formula：此行定义公式类并从 Homebrew 的 Formula 类继承。
• desc：软件的简短描述。
• homepage：软件主页的 URL。
• url：可以下载软件源代码或二进制文件的 URL。
• sha256：从 URL 下载的文件的 SHA256 校验和。 这验证了文件的完整性。
• version：软件的版本。
• def install：此方法定义如何安装软件。 bin.install 将可执行文件复制到由 Homebrew 管理的目录中。

步骤 5：提交并推送更改

1. 编写公式后，保存文件。
2. 返回到存储库的根目录：

cd ..

3. 使用以下 git 命令来阶段、提交和推送对 GitHub 的更改：

git add .
git commit -m "Add awesome tool formula"
git push origin main

步骤 6：测试您的 tap

在与他人共享您的 tap 之前，务必测试它以确保其按预期工作：

1. 要使用您的 tap，首先使用以下命令将其添加到 Homebrew：

brew tap <username>/<name>

2. 使用 brew install 命令安装您的软件：

brew install awesome-tool

3. 验证软件是否已安装并正常运行。

步骤 7：维护您的 tap

部署 tap 后，维护它很重要。 这包括使用新软件版本更新公式并注意用户遇到的任何问题。 这里有一些小贴士：

• 发布新版本的软件时，更新公式文件中的 version、url 和 sha256。
• 使用 git 工作流程提交并推送对您的 tap 的更新。
• 回应提交到您的存储库的任何问题或拉取请求。

额外提示

以下是在构建和维护 Homebrew tap 时需要记住的一些额外提示和最佳实践：

• 编写清晰简单的公式。 确保每个公式易于阅读和理解。
• 使用有意义的提交消息来记录更改。
• 确保您的公式拥有有意义的测试用例（在可能的情况下）。
• 通过讨论问题和欢迎贡献，积极与社区互动。
• 定期查看 Homebrew 文档以获取有关任何最佳实践或更改的更新。

在 GitHub 上创建 Homebrew tap 是将软件分发给大量受众的好方法，几乎不费任何力气。 通过遵循本指南中的步骤，您可以设置 tap 并使用户能够轻松通过 Homebrew 安装您的软件。 无论是个人使用还是大规模分发，利用 Homebrew tap 都可以简化 macOS 和 Linux 上的软件安装。

  分享本文

如果你发现文章内容有误, 您可以 请求更新