Teach you step by step to publish your own CocoaPods open source library

Follow the steps below to publish your own cocoapods open source library. It is made with conscience and will teach you everything you need!!

Below I will explain the whole process through a project called IFMMenu.

1. Write the code and upload it to github

When creating a project repository on GitHub, remember to create a LICENSE (license/authorization) file. This file is required.

Create a project repository on GitHub

2. Tag your project

Because cocoapods relies on tag versions, you must tag your project. To update it again in the future, you only need to tag your project, then modify the version in the .podspec file and submit it to the cocoapods official. Please see the submission command below

 //Tag for git, add a v in front of it for the first time 
 
 git tag "v1.0.0"   
 
 git push --tags  

3. Register CocoaPods

Trunk requires CocoaPods version 0.33 or above. Use the pod --version command to check the version. If the version is lower, you need to upgrade.

 pod --version   
 
 //Version lower than 0.33 
 
 sudo gen install cocoapods 
 
 pod setup

If you have already registered, you do not need to register. How can you check whether you have registered?

 pod trunk me

pod trunk me information

If you are not registered, execute the following command, and enter your email and username. I use the username on Github.

 // Adding --verbose can output detailed error information, which is convenient for viewing when an error occurs.   
 
 pod trunk register [email protected] 'liugangios'   --verbose  

After registration is completed, an email will be sent to your mailbox. There is a link in the email and you need to click to confirm.

After registration is complete, use pod trunk me to verify whether the registration is successful.

4. Create .podspec

cd to your project directory and execute the command

 pod spec create IFMMenu

5. Edit .podspec

After creation, open .podspec, delete the comments, the ones with # in front are comments, or you can replace them with the following code, and then edit your own library information.

 Pod::Spec.new do |s| 
 
 s.name = 'IFMMenu'   
 
 s.version = '1.0.2'   
 
 s.authors = { 'liugangios' => '[email protected]' } 
 
 s.homepage = 'https://github.com/liugangios/IFMMenu'   
 
 s.summary = 'a dropdown menu for ios like wechat homepage.'   
 
 s.source = { :git => 'https://github.com/liugangios/IFMMenu.git' , 
 
 :tag => s.version.to_s } 
 
 s.license = { :type => "MIT" , :file => "LICENSE" } 
 
 s.platform = :ios, '7.0'   
 
 s.requires_arc = true   
 
 s.source_files = 'IFMMenu'   
 
 s.public_header_files = 'IFMMenu/*.h'   
 
 s.ios.deployment_target = '7.0'   
 
 end  

• s.name: name, the keyword for pod search. Note that this must be the same as the name of .podspec, otherwise an error will be reported
• s.version: version number, to_s: returns a string
• s.author: author
• s.homepage: project homepage address
• s.summary: Project introduction
• s.source: The address of the project source code
• s.license: License
• s.platform: Project support platform
• s.requires_arc: whether to support ARC
• s.source_files: source files that need to be included
• s.public_header_files: header files that need to be included
• s.ios.deployment_target: supported pod*** versions

Other non-essential fields

• s.social_media_url: social media URL
• s.resources: resource files
• s.dependency: Dependency library, cannot depend on unpublished libraries

 s.license= { :type => “MIT”, :file => “LICENSE” }

It is recommended to write it like this. If you write something else, a warning will be reported, resulting in subsequent submission failures.

Source_files writing method and meaning

 "IFMMenu/* 
 
 "IFMMenu/IFMMenu/*.{h,m}"   
 
 "IFMMenu/**/*.h"  

* means match all files

*.{h,m} means matching all files ending with .h and .m

** means match all subdirectories

s.source common writing method

 s.source = { :git => "https://github.com/liugangios/IFMMenu.git" , : commit => "68defea" } 
 
 s.source = { :git => "https://github.com/liugangios/IFMMenu.git" , :tag => 1.0.0 } 
 
 s.source = { :git => "https://github.com/liugangios/IFMMenu.git" , :tag => s.version }

• commit => "68defea" means binding this Pod version to a commit in the Git repository
• tag => 1.0.0 means binding this Pod version to a certain version of comit in the Git repository
• tag => s.version means binding this Pod version to the same version of comit in the Git repository

6. Verify .podspec

Check here to see if you have the following files in your project:

• Your project,
• .podspec file,
• LICENSE file

Project files

Use the following command to test your local .podspec file for syntax errors.

 pod spec lint IFMMenu.podspec --verbose  

7. Release

 pod trunk push IFMMenu.podspec

It takes a long time, please wait patiently, about 5-10 minutes, and the following prompt will appear after the release is successful

Post a successful screenshot

8. Test your own cocoapods

At this time, if you use pod search to search, you will be prompted that the search is not found. You can execute the following command to update the local search_index.json file

 rm ~/Library/Caches/CocoaPods/search_index.json

Then

 pod search IFMMenu

This command will recreate the search_index.json file. Please wait patiently for 5-10 minutes.

Search Results

Full command

 git tag "v1.0.0"   
 
 git push --tags   
 
 pod trunk register [email protected] 'liugangios'   --verbose   
 
 pod trunk me 
 
 pod spec create IFMMenu 
 
 //Edit IFMMenu.podspec 
 
 pod spec lint IFMMenu.podspec 
 
 pod trunk push IFMMenu.podspec 
 
 rm ~/Library/Caches/CocoaPods/search_index.json 
 
 pod search IFMMenu

Error handling

 [!] Unable to accept duplicate entry for : XXXXX (1.0.0)

Meaning: cannot accept submissions of the same version

Solution:

1. Execute the following command

 git tag 1.0.1 
 
 git push --tags  

2. Modify the content in the XXXX.podspec file

 s.version = "1.0.1"   
 
 s.source = { :Git => "https://github.com/xxx/xxx.git" , :tag => "1.0.1" }

3. Execute the commands pod spec lint, pod trunk push library name. podspec to verify and submit to CocoPods

***

IFMMenu is a multifunctional, customizable drop-down menu that mimics the menu added to the WeChat homepage. Welcome to download and give comments, star, and thank you for reading.