添加软件包
任何人都可以向 Swift Package Index 添加软件包。请随时向索引提交任何软件包仓库,无论它是由您还是其他人编写的软件包。也没有质量门槛。只要软件包有效并满足以下要求,我们就会接受它们。如果您不确定任何要求,请提交软件包,我们将很乐意提供帮助。
索引收录有一些要求,但它们并不苛刻
- 软件包仓库必须全部公开访问。
- 软件包必须全部在根文件夹中包含有效的
Package.swift
文件。 - 软件包必须使用 Swift 5.0 或更高版本编写。
- 软件包应至少有一个发布版本标记为语义版本。
- 当使用最新的 Swift 工具链运行
swift package dump-package
时,软件包必须全部输出有效的 JSON。 - 软件包 URL 必须包含协议(通常是
https
)和.git
扩展名。 - 软件包必须全部编译无错误。
- 所有软件包内容必须遵守我们的行为准则。
注意: 我们的构建系统现在可以生成和托管 DocC 文档,并使其可以从您在索引中的软件包页面访问。我们只需要一点配置数据,以便我们知道如何最好地构建您的文档。
注意: 如果提交您自己的软件包,请不要忘记在您软件包的 README 中添加 shields.io 徽章,以便始终拥有最新的 swift 版本和平台兼容性信息。一旦您的软件包出现在索引中,请使用您软件包页面右侧边栏中的“您维护此软件包吗?”链接,并使用提供的 markdown。
例如
移除软件包
您可以通过此 GitHub 工作流程请求从索引中移除软件包。