Kinvey Swift SDK
Kinvey Swift SDK 是一套可用于在 Kinvey 平台上开发 iOS 应用程序的软件包。有关使用 Kinvey 的说明,请参阅 Kinvey DevCenter。
在库的 3 版本中,所有新代码都是用 Swift 编写的,并且使用 v3 的任何应用程序都必须使用 Swift 来访问 API。
在我们从 Objective C 过渡到最新的 Swift 版本的期间,我们将使用以下分支规划。请根据您正在使用的语言/版本选择我们库的正确版本。
语言 / 版本 | Kinvey SDK 版本 | 开发分支 |
---|---|---|
Swift 3 和 Swift 4 | 3.3.0 及以上 | master |
Swift 2.3 | 3.2.x | 3.2 |
Objective-C | 1.x | 1.x |
说明
- `master` 分支代表 SDK 的最新 发布。有关提交代码的详细信息,请参阅 贡献指南。
- 在版本 1.x 中,使用 `KinveyKit` 工作空间。在其他所有版本中,使用 `Kinvey` 工作空间。
构建
您需要安装 Carthage、Jazzy 和 Xcode 命令行工具
,才能构建 SDK。
make
:依次运行构建、归档、打包和文档命令,使用Jazzy
生成项目构建和打包,以及文档文件。
检查Makefile以获取所有可用命令。
测试
使用Xcode
运行单元测试。
- 在Xcode中打开文件
Kinvey.xcworkspace
。 - 选择
Kinvey
方案。 - 选择菜单项“产品”->“测试”或按
Command+U
。
或者运行命令行
make test
Important Note: adding the environment variables KINVEY_APP_KEY, KINVEY_APP_SECRET and KINVEY_MIC_APP_KEY will allow you to run the tests against a real Kinvey environment.
发布
我们使用GitFlow流程来更好地管理。
发布SDK新版本的流程如下
- 将所有等待的pull请求/功能分支合并到develop分支。
- 增加版本,在develop分支上运行
make set-version
。 - 检出master分支,将develop分支合并。
- 使用git打上版本标签。
- 推送所有更改。
- 上传包含所有二进制文件的zip文件到亚马逊AWS。
- 在
CocoaPods
上运行make deploy-cocoapods
以发布新的发布版本 - 在DevCenter仓库中发布
release notes
、API参考文档
和下载
部分。 - 推送所有更改以部署。
- 给
客户服务
和开发
团队发送包含发布说明的电子邮件。
版本管理
更新SDK版本应遵循语义版本2.0.0
- 主版本(x.0.0):当进行不兼容API更改时。
- 次版本(3.x.0):当以前向后兼容的方式添加功能时。
- 修订版本(3.0.x):当进行向后兼容的bug修复或增强时。
许可证
详见 LICENSE 获取详细信息。
贡献
详见 CONTRIBUTING.md 了解bug报告和贡献的详细信息。