关于 Swift Package Scripts

Swift Package Scripts 让你能够轻松地构建和测试你的 Swift Package，生成 DocC 文档和 XCFrameworks，以及创建新版本。

scripts 文件夹包含以下脚本：

• build.sh - 为所有提供的平台运行构建。
• chmod.sh - 在 scripts 文件夹中的所有脚本上运行 chmod +x。
• docc.sh - 为所有提供的平台构建 DocC 文档。
• framework.sh - 为所有提供的平台构建 XCFramework。
• git_default_branch.sh - 获取默认的 git 分支名称。
• package_docc.sh - 为主要的 Swift Package 构建 DocC 文档。
• package_framework.sh - 为主要的 Swift Package 构建 XCFramework。
• package_name.sh - 获取主要的 Swift Package 的名称。
• package_version.sh - 为主要的 Swift Package 创建一个新版本。
• sync_from.sh - 从 Swift Package Scripts 文件夹同步 scripts 文件夹。
• test.sh - 为所有提供的平台运行项目单元测试。
• version.sh - 创建具有验证和测试步骤的新版本。
• version_bump.sh - 提升版本号并推送新的版本标签。
• version_number.sh - 获取当前的 git 版本号。
• version_validate_git.sh - 验证 git 仓库是否已准备好发布。
• version_validate_target.sh - 验证目标是否已准备好发布。

请注意，您可能需要运行 chmod +x <SCRIPT> 才能运行脚本。

可以通过克隆存储库将 Swift Package Scripts 安装到您的计算机上。

git clone https://github.com/danielsaidi/SwiftPackageScripts.git

然后，您可以导航到该文件夹并将脚本同步到您机器上的任何较旧的文件夹。

sync_to.sh 脚本可用于将整个 scripts 文件夹同步到另一个文件夹

./sync_to.sh ../MyOtherProject

这将删除任何已存在的文件夹，并将其替换为最新版本。

您还可以从另一个文件夹运行 scripts/sync_from.sh，以更新其 scripts 文件夹

./scripst/sync_from.sh ../SwiftPackageScripts

这意味着您可以轻松地使您的项目与此项目的本地副本保持同步。

.github/workflows 文件夹包含 build 和 docc runner 文件，这些文件用于在每次推送到主分支时，使用 GitHub Actions 运行测试并构建 DocC 文档。

这些 GitHub 脚本不属于同步的一部分。您可以手动将它们复制到您自己的项目，以将这些脚本与 GitHub Actions 集成。

此存储库有一个示例 package，用于测试一切是否按预期工作。

有关这些脚本的更多信息，以及如何设置特定于项目的脚本，请参阅在线 文档。

您可以在 GitHub Sponsors 上 赞助我，或者 联系我 以获得付费支持，以帮助支持我的 开源项目。

您的支持使我有可能投入更多精力到这些项目中，并使它们成为最好的。

如果您有任何问题或想以任何方式做出贡献，请随时联系

• 网站：danielsaidi.com
• Mastodon: @danielsaidi@mastodon.social
• Twitter: @danielsaidi
• 电子邮件: daniel.saidi@gmail.com

SystemNotification 在 MIT 许可下可用。 有关更多信息，请参见 LICENSE 文件。