模板包

该模板仓库包含一个模板 Swift 包，其中包括持续集成设置。

请按照以下步骤根据您的需求进行自定义

1. 重命名 Swift 包。请务必相应地更新 build-and-test.yml GitHub Action 中的名称。 如果您的 Swift 包中有多个目标，则需要将 Swift 包的名称加上 -Package 作为 scheme 传递给 GitHub Action，例如，如果您的 Swift 包名为 StanfordProject，则传递 StanfordProject-Package。
2. 如果您的 Swift 包不提供任何用户界面，或者不需要 iOS 应用程序环境即可运行，则可以从 Tests 文件夹中删除 UITests 应用程序。 您需要相应地更新 build-and-test.yml GitHub Action，方法是删除构建和测试应用程序的 GitHub Action，从代码覆盖率上传步骤中删除依赖项，并从代码覆盖率测试中删除 UI 测试 .xresult 输入。
3. 如果您的 Swift 包使用 UI 测试，您需要...
   • ...将其添加到 scheme 编辑器（Scheme > Edit Scheme），并将您的目标添加到“Build”配置中，并确保在为“Test”配置构建时，它在测试应用程序目标之前构建。 不需要为其他配置（如“Analyze”、“Run”、“Profile”或“Archive”）启用构建。
   • ...将其添加为主目标配置中的链接框架（在您的 Xcode 项目设置中，选择您的测试应用程序目标 > General > Frameworks, Libraries, and Embedded Comments）。
   • ...确保所有目标都已添加到 Xcode 项目中的 .xctestplan 文件的代码覆盖率设置中（Shared Settings > Code Coverage > Code Coverage）。
4. 您将需要添加 CodeCov GitHub App 或将 codecov.io 令牌添加到您的 GitHub Actions Secrets，方法是按照 Codecov GitHub Action 的说明进行操作。 StanfordBDHG 组织已经安装了 CodeCov GitHub App。 如果您不想涵盖测试覆盖率数据，则可以删除 build-and-test.yml GitHub Action 中的代码覆盖率作业。
5. 调整此 README.md 文件以描述您的项目，并调整顶部的徽章以指向您的仓库和 Codecov 徽章的正确 GitHub Action。
6. Swift Package 模板包含一个 Swift Package Index 配置文件，用于自动构建软件包和 在 Swift Package Index 网站上托管文档。 调整 .spi.yml 文件以包含要为其构建文档的所有目标。 您可以按照 Swift Package Index 的说明将您的 Swift Package 包含在 Swift Package Index 中。 您可以从 README 文件链接到 API 文档。
7. 调整 CITATION.cff 文件以修改有关新 Swift 包的信息（了解有关 GitHub 上 CITATION 文件的更多信息）和 在 Zenodo 上注册 Swift 包。

可以使用 Swift Package Manager 将该项目添加到您的 Xcode 项目或 Swift Package。

Xcode： 对于 Xcode 项目，请按照 将软件包依赖项添加到您的应用程序的说明进行操作。

Swift Package： 您可以按照 有关定义依赖项的 Swift Package Manager 文档，将此项目添加为您的 Swift Package 的依赖项。

本项目根据 MIT 许可证获得许可。 有关更多信息，请参见 Licenses。

本项目是斯坦福大学斯坦福 Byers Center for Biodesign 的一部分。 有关所有 TemplatePackage 贡献者的完整列表，请参见 CONTRIBUTORS.md。