tartelet

👋 欢迎使用 Tartelet - 一款使用 Tart 在虚拟机中启动自托管 GitHub Actions 运行器的 macOS 应用程序。

Tartelet 让您可以轻松地在单个主机上管理最多两个在临时虚拟机中运行的 GitHub Actions 运行器。好处是运行器可以并行运行，每个作业都在独立的环境中运行，该环境在每个 GitHub Actions 作业完成后都会重新创建。

• 🚀 入门指南
• 👨‍🔧 它是如何工作的？
• 🏎 性能如何？
• 👩‍💻 我如何贡献？
• 🤨 为什么叫 Tartelet？
• 🙏 致谢

🚀 入门指南

请参阅wiki中的以下文章开始使用 Tartelet。

• 安装 Tartelet
• 配置 Tartelet
• 启动虚拟机

👨‍🔧 它是如何工作的？

Tartelet 使用 Tart 管理虚拟机，而 Tart 则使用 Apple 的 虚拟化框架。由 Tartelet 管理的 GitHub Actions 运行器的生命周期如下：

1. Tartelet 使用 Tart 克隆一个虚拟机。
2. 虚拟机启动。
3. 机器启动后，运行设置脚本。该脚本下载最新版本的 GitHub 运行器应用程序 并在 GitHub 组织中注册运行器。
4. 运行器监听作业并执行。
5. 执行作业后，运行器自动从 GitHub 组织中移除自己。
6. 虚拟机关闭。
7. Tartelet 使用 Tart 删除虚拟机。

最后一步完成后，过程重新开始。

🏎 性能如何？

性能取决于运行应用程序的硬件。在 2020 年的 Mac mini M1（16 GB 内存）上测试时，我们发现我们的作业运行速度比 GitHub 的运行器快 3 - 4 倍。

我们发现，与运行单个虚拟机相比，并行运行两个虚拟机时，我们的作业运行速度大约慢 12%。我们认为这种性能成本可以忽略不计，因为运行两个虚拟机显著提高了我们的吞吐量，而金钱成本较低。

这意味着 Tartelet 可以同时运行两个虚拟机。这是 Apple 的虚拟化框架允许我们同时运行的最大虚拟机数量。

作业完成后，运行该作业的虚拟机会关闭并销毁，然后创建并启动一个新的虚拟机。这个过程大约需要 25 - 30 秒。然而，在大多数情况下，这种开销并不显著，因为 Tartelet 在每个作业完成后都会创建一个新的虚拟机。这意味着新的虚拟机及其 GitHub Actions 运行器已准备好处理下一个作业。除非 GitHub 上排队的作业数量超过可用的虚拟机数量，否则创建和启动虚拟机的开销就变得可以忽略不计。

这些数据最后更新于 2023 年 1 月/2 月。

👩‍💻 我如何贡献？

我们非常感谢包含错误修复和新功能的拉取请求。我们很乐意审查 PR 并在准备就绪后合并它们，只要它们包含符合 Tartelet 愿景的更改。

克隆仓库以开始处理项目。

git clone git@github.com:shapehq/tartelet.git

使用 XcodeGen 生成项目文件

克隆仓库后，您会注意到项目中没有 .xcodeproj 文件。这应该使用 XcodeGen 生成。使用 Homebrew 在终端中运行以下命令安装 XcodeGen。

brew install xcodegen

安装 XcodeGen 后，可以通过运行以下命令生成项目文件。

xcodegen generate

使用 SwiftGen 生成资源常量

我们使用 SwiftGen 为图像、颜色和本地化生成常量。使用 Homebrew 在终端中运行以下命令安装 SwiftGen。

brew install swiftgen

然后通过在终端中运行以下命令生成图像、颜色和本地化的常量。

swiftgen

仓库根目录下的 swiftgen.yml 文件描述了如何生成常量。

配置项目以在您的机器上运行

要在本地运行项目，需要编辑 Tartelet.entitlements 文件以指定您控制的钥匙串访问组。然后，您需要编辑 Composers.swift 文件以确保使用 entitlements 文件中指定的钥匙串访问组初始化钥匙串。如果不这样做，应用程序将无法将设置持久化到钥匙串。

换句话说，您需要在项目中搜索 $(AppIdentifierPrefix)dk.shape.Tartelet 和 566MC7D8D4.dk.shape.Tartelet，并将出现的内容替换为对您的钥匙串访问组的引用。

使用 SwiftLint 对代码库进行 Lint 检查

我们使用 SwiftLint 确保代码的统一性。使用 Homebrew 在终端中运行以下命令安装 SwiftLint。

brew install swiftlint

🤨 为什么叫 Tartelet？

该应用程序之所以命名为 Tartelet，是因为它基于 Tart，这是一个用于管理 macOS 虚拟机的开源 CLI。Tartelet 使使用 Tart 运行多个虚拟机变得容易。丹麦语中"容易"的意思是"let"。"Tart" + "e" + "let" = "Tartelet"，而 tartelet 是一种传统的丹麦食物。

<img src="https://yellow-cdn.veclightyear.com/835a84d5/eb637f19-5621-4039-8539-bc053f45d878.png?raw=true" width="192" />

🙏 致谢

• Tart 完成了创建、克隆和运行虚拟机的所有繁重工作。
• Tartelet 深受 Cilicon 的启发。

---

Tartelet 由丹麦的 Shape 用❤️打造。哦，我们正在 招聘 🤗