当前位置:   article > 正文

[iOS]使用CocoaPods发布私有库

[iOS]使用CocoaPods发布私有库

1.创建私有 Spec 仓库

首先,需要一个私有的 Git 仓库来存放你的 Podspec 文件,这个仓库用于索引你所有的私有 Pods。

  • 在 GitHub 或其他 Git 服务上创建一个新的私有仓库,例如,名为 PrivatePodSpecs
  • 克隆这个仓库到本地:
$ git clone https://github.com/yourusername/PrivatePodSpecs.git

一个私有 Spec 仓库可以对应N个组件库

一个私有 Spec 仓库可以包含多个组件库(Pods)。这是一个非常常见的做法,特别是在大型项目或组织中,将多个相关的私有库集中管理。这样做有几个优点:

优点:

  • 集中管理:通过一个仓库管理所有私有库,可以更容易地维护版本控制和依赖关系。
  • 访问控制:只需要设置和管理一个仓库的访问权限,就可以控制所有私有库的访问。
  • 依赖解决:当多个库相互依赖时,使用同一个 Spec 仓库可以简化依赖解决的过程。
  • 版本同步:在一个仓库中管理多个库可以更容易地同步这些库的发布周期和版本号。
  1. source 'https://gitee.com/fzym/private-pod-specs.git'
  2. platform :ios, '10.0'
  3. target 'GaminComponentDemo' do
  4. use_frameworks!
  5. pod 'MyComponent', '0.0.3'
  6. pod 'MyOtherComponent', '0.0.1'
  7. end

2.准备你的组件库

确保你的库的代码已经在一个可访问的 Git 仓库中(比如 GitHub 的私有仓库)。库中应该包含:

  • 所有源代码
  • 许可证文件
  • README 文件,说明库的功能和使用方法

3.创建 Podspec 文件

在你的库项目的根目录下,执行以下命令来创建一个基本的 Podspec 文件:

$ pod spec create YourLibrary

这将创建一个名为 YourLibrary.podspec 的文件,其中 YourLibrary 是你的库的名字。CocoaPods 会自动填充一些基本的模板内容到这个文件中。

  1. #
  2. # Be sure to run `pod spec lint MyComponent.podspec' to ensure this is a
  3. # valid spec and to remove all comments including this before submitting the spec.
  4. #
  5. # To learn more about Podspec attributes see https://guides.cocoapods.org/syntax/podspec.html
  6. # To see working Podspecs in the CocoaPods repo see https://github.com/CocoaPods/Specs/
  7. #
  8. Pod::Spec.new do |spec|
  9. # ――― Spec Metadata ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  10. #
  11. # These will help people to find your library, and whilst it
  12. # can feel like a chore to fill in it's definitely to your advantage. The
  13. # summary should be tweet-length, and the description more in depth.
  14. #
  15. spec.name = "MyComponent"
  16. spec.version = "0.0.1"
  17. spec.summary = "A short description of MyComponent."
  18. # This description is used to generate tags and improve search results.
  19. # * Think: What does it do? Why did you write it? What is the focus?
  20. # * Try to keep it short, snappy and to the point.
  21. # * Write the description between the DESC delimiters below.
  22. # * Finally, don't worry about the indent, CocoaPods strips it!
  23. spec.description = <<-DESC
  24. DESC
  25. spec.homepage = "http://EXAMPLE/MyComponent"
  26. # spec.screenshots = "www.example.com/screenshots_1.gif", "www.example.com/screenshots_2.gif"
  27. # ――― Spec License ――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  28. #
  29. # Licensing your code is important. See https://choosealicense.com for more info.
  30. # CocoaPods will detect a license file if there is a named LICENSE*
  31. # Popular ones are 'MIT', 'BSD' and 'Apache License, Version 2.0'.
  32. #
  33. spec.license = "MIT (example)"
  34. # spec.license = { :type => "MIT", :file => "FILE_LICENSE" }
  35. # ――― Author Metadata ――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  36. #
  37. # Specify the authors of the library, with email addresses. Email addresses
  38. # of the authors are extracted from the SCM log. E.g. $ git log. CocoaPods also
  39. # accepts just a name if you'd rather not provide an email address.
  40. #
  41. # Specify a social_media_url where others can refer to, for example a twitter
  42. # profile URL.
  43. #
  44. spec.author = { "" => "" }
  45. # Or just: spec.author = ""
  46. # spec.authors = { "" => "" }
  47. # spec.social_media_url = "https://twitter.com/"
  48. # ――― Platform Specifics ――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  49. #
  50. # If this Pod runs only on iOS or OS X, then specify the platform and
  51. # the deployment target. You can optionally include the target after the platform.
  52. #
  53. # spec.platform = :ios
  54. # spec.platform = :ios, "5.0"
  55. # When using multiple platforms
  56. # spec.ios.deployment_target = "5.0"
  57. # spec.osx.deployment_target = "10.7"
  58. # spec.watchos.deployment_target = "2.0"
  59. # spec.tvos.deployment_target = "9.0"
  60. # spec.visionos.deployment_target = "1.0"
  61. # ――― Source Location ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  62. #
  63. # Specify the location from where the source should be retrieved.
  64. # Supports git, hg, bzr, svn and HTTP.
  65. #
  66. spec.source = { :git => "http://EXAMPLE/MyComponent.git", :tag => "#{spec.version}" }
  67. # ――― Source Code ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  68. #
  69. # CocoaPods is smart about how it includes source code. For source files
  70. # giving a folder will include any swift, h, m, mm, c & cpp files.
  71. # For header files it will include any header in the folder.
  72. # Not including the public_header_files will make all headers public.
  73. #
  74. spec.source_files = "Classes", "Classes/**/*.{h,m}"
  75. spec.exclude_files = "Classes/Exclude"
  76. # spec.public_header_files = "Classes/**/*.h"
  77. # ――― Resources ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  78. #
  79. # A list of resources included with the Pod. These are copied into the
  80. # target bundle with a build phase script. Anything else will be cleaned.
  81. # You can preserve files from being cleaned, please don't preserve
  82. # non-essential files like tests, examples and documentation.
  83. #
  84. # spec.resource = "icon.png"
  85. # spec.resources = "Resources/*.png"
  86. # spec.preserve_paths = "FilesToSave", "MoreFilesToSave"
  87. # ――― Project Linking ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  88. #
  89. # Link your library with frameworks, or libraries. Libraries do not include
  90. # the lib prefix of their name.
  91. #
  92. # spec.framework = "SomeFramework"
  93. # spec.frameworks = "SomeFramework", "AnotherFramework"
  94. # spec.library = "iconv"
  95. # spec.libraries = "iconv", "xml2"
  96. # ――― Project Settings ――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  97. #
  98. # If your library depends on compiler flags you can set them in the xcconfig hash
  99. # where they will only apply to your library. If you depend on other Podspecs
  100. # you can include multiple dependencies to ensure it works.
  101. # spec.requires_arc = true
  102. # spec.xcconfig = { "HEADER_SEARCH_PATHS" => "$(SDKROOT)/usr/include/libxml2" }
  103. # spec.dependency "JSONKit", "~> 1.4"
  104. end

4.编辑 Podspec 文件

打开 YourLibrary.podspec 文件,在编辑器中进行修改,以符合你的库的具体情况。以下是 Podspec 文件的一个例子及其解释:

  1. Pod::Spec.new do |s|
  2. s.name = "YourLibrary"
  3. s.version = "0.0.1"
  4. s.summary = "A short description of YourLibrary."
  5. s.description = <<-DESC
  6. An optional longer description of YourLibrary.
  7. DESC
  8. s.homepage = "http://example.com/YourLibrary"
  9. s.license = { :type => "MIT", :file => "LICENSE" }
  10. s.author = { "Your Name" => "you@example.com" }
  11. s.source = { :git => "https://github.com/yourusername/YourLibrary.git", :tag => "#{s.version}" }
  12. s.source_files = "Sources/**/*.{h,m,swift}"
  13. s.platform = :ios, '10.0'
  14. s.swift_version = '5.0'
  15. # 添加对 Moya 的依赖
  16. #s.dependency 'Moya', '~> 15.0.0'
  17. # 添加对 SwiftyJSON 的依赖
  18. #s.dependency 'SwiftyJSON', '5.0.1'
  19. end
  • name: 库的名称。
  • version: 库的版本号。这个版本应该与 Git 标签(tag)一致。
  • summary: 库的简短描述。
  • description: 库的详细描述。
  • homepage: 库的主页 URL。
  • license: 许可证类型和文件位置。
  • author: 库的作者信息。
  • source: 指定库的源代码位置,通常是一个 Git 仓库。
  • source_files: 指定包括在库中的源文件。
  • platform: 指定库支持的平台及最低版本。
  • swift_version: 指定所需的 Swift 版本。
  • dependency:依赖。如果组件需要依赖多个库,您可以在 .podspec 文件中连续添加多个 dependency 属性。每个依赖都应该以单独的 s.dependency 行来声明。这让您可以明确指定每个依赖库的名称和版本要求。

注意更新你组件库中的标签或分支

MyComponent.podspec 文件中的 s.source 参数,确保其指向正确的 URL 和分支或标签。

先确保你的组件库有你配置这个分支或标签,然后你再配置分支的名称或tag。

标签(Tag):

标签是指向 Git 仓库中某一特定提交的引用,通常用于标记发布点(如版本发布)。标签是静态的,指向特定的提交,不会随着更多的提交而变化。

在 podspec 文件中使用标签,通常意味着你指定了一个稳定的、用于发布的版本。这是最常见的用法,因为这确保了项目的依赖是固定且可预测的。例如:

s.source = { :git => 'https://gitee.com/fzym/my-component.git', :tag => '0.0.1' }

 分支(Branch):

分支是用于开发新功能、修复错误或进行实验而创建的代码的独立线路。创建分支可以让你在不影响主线(通常是 master 或 main 分支)的情况下开发和测试代码。

在 podspec 文件中指定分支,意味着 CocoaPods 将从这个特定分支拉取代码。这通常用于开发阶段,当你想要使用最新的尚未发布的代码时。

s.source = { :git => 'https://gitee.com/fzym/my-component.git', :branch => 'develop' }

这里,develop 分支可能包含最新的开发中的功能和修复。

5.验证 Podspec 文件

在完成编辑后,你需要验证 Podspec 文件来确保配置无误:

$ pod lib lint

 这个命令将检查你的 Podspec 文件是否有错误或者遗漏的必要信息。如果一切顺利,你将看到 "passed validation" 的消息。

6.将 Podspec 推送到你的私有 Spec 仓库

推送到私有 Spec 仓库:

一旦 Podspec 文件准备好并且验证通过,可以将其添加到你的私有 Spec 仓库:

  1. $ pod repo add PrivateRepoName https://github.com/yourusername/PrivatePodSpecs.git
  2. $ pod repo push PrivateRepoName YourLibrary.podspec

 这里 PrivateRepoName 是你给你的私有 Spec 仓库设定的本地名称。

重命名仓库:

如果需要重命名仓库,你可以这样做:

  1. $ pod repo remove OldPrivateRepoName
  2. $ pod repo add NewPrivateRepoName https://github.com/yourusername/PrivatePodSpecs.git

查看所有已添加的仓库:

如果你忘记了你为私有仓库设置的本地别名 PrivateRepoName,你可以很容易地查看你的 CocoaPods 配置来找到所有已添加的私有仓库及其别名。这可以通过在终端运行一个简单的命令来完成。

$ pod repo list

6.使用你的私有库

在项目的 Podfile 中指定你的私有 Spec 仓库和库:

  1. # 私有 Specs 仓库
  2. source 'https://github.com/yourusername/PrivatePodSpecs.git'
  3. # 这是一个用于存储 CocoaPods 库的公共资源,并且是官方推荐的替代源,用来代替传统的 GitHub 基于的 Specs 仓库。
  4. source 'https://cdn.cocoapods.org/'
  5. platform :ios, '10.0'
  6. target 'YourTarget' do
  7. use_frameworks!
  8. pod 'YourLibrary', '~> 0.0.1'
  9. pod 'MyComponent', '0.0.1', :source => 'https://github.com/yourusername/PrivatePodSpecs.git'
  10. pod 'Toast-Swift', '5.0.1'
  11. end

然后运行:

$ pod install

运行报错

安装依赖成功,但是运行报错:

error: Sandbox: rsync.samba(44912) deny(1) file-write-create /Users/gamin/Library/Developer/Xcode/DerivedData/GaminComponentDemo-fksconsdxioqokgfmgdlkdmudypx/Build/Products/Debug-iphonesimulator/GaminComponentDemo.app/Frameworks/MyComponent.framework/_CodeSignature (in target 'GaminComponentDemo' from project 'GaminComponentDemo')
error: Sandbox: rsync.samba(44913) deny(1) file-write-create /Users/gamin/Library/Developer/Xcode/DerivedData/GaminComponentDemo-fksconsdxioqokgfmgdlkdmudypx/Build/Products/Debug-iphonesimulator/GaminComponentDemo.app/Frameworks/MyComponent.framework/.Info.plist.IoLml8 (in target 'GaminComponentDemo' from project 'GaminComponentDemo')
error: Sandbox: rsync.samba(44913) deny(1) file-write-create /Users/gamin/Library/Developer/Xcode/DerivedData/GaminComponentDemo-fksconsdxioqokgfmgdlkdmudypx/Build/Products/Debug-iphonesimulator/GaminComponentDemo.app/Frameworks/MyComponent.framework/.MyComponent.HK9Aoa (in target 'GaminComponentDemo' from project 'GaminComponentDemo')

解决:

检查项目的构建设置中是否禁用了 ENABLE_USER_SCRIPT_SANDBOXING。

""

如果您想保持 ENABLE_USER_SCRIPT_SANDBOXING 启用来修复这个问题,应该将文件添加为输入和输出。

我使用脚本在构建信息 plist 文件中设置构建号。 我只需要将“${TARGET_BUILD_DIR}/${INFOPLIST_PATH}”设置为脚本的输出

构建设置 ENABLE_USER_SCRIPT_SANDBOXING 已在 Xcode 14 中添加,但在Xcode 15 中默认启用

来自 Xcode 14 发行说明:

现在,您可以使用 ENABLE_USER_SCRIPT_SANDBOXING 构建设置为 shell 脚本构建阶段启用沙箱。 沙箱会阻止对项目源根目录以及派生数据目录内的文件的访问,除非您将这些文件列为输入或输出。 启用后,如果脚本阶段尝试读取或写入未声明的依赖项,则构建会因沙箱冲突而失败,从而防止错误构建。

感谢 Daniel Jalket 的博客文章:Xcode 构建脚本沙盒 - https://indiestack.com/2023/06/xcode-build-script-sandboxing/

""

相关问题:

Xcode 15 beta build issues | Apple Developer Forums

Xcode 15 cannot copy frameworks to app bundle possibly due to sandboxing issues · Issue #11946 · CocoaPods/CocoaPods · GitHub

 Xcode Build Script Sandboxing | Indie Stack

7.更新库

当你需要更新你的库时:

  • 更新你的库代码。
  • 修改 Podspec 文件中的版本号,并确保更新 tag。
  • 推送新代码到你的库的 Git 仓库,并创建相应的新 tag。
  • 将更新后的 Podspec 推送到私有 Spec 仓库:
$ pod repo push PrivateRepoName YourLibrary.podspec
  • 在使用该库的项目中,运行 pod update 来拉取最新版本。

8.管理权限

由于你的库和 Spec 仓库是私有的,确保只向需要的团队成员和合作者提供访问权限。

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/小小林熬夜学编程/article/detail/502959
推荐阅读