App Development

How to Fix Unexpected Podfile.lock Diffs After Pod Install

If you are working with other developers on a project using Cocoapods, then you may have seen the below change in your Podfile.lock when trying to install pods. It can be frustrating to see this diff when you have made no changes.

cocoapod image 1

The Issue

What is happening is that your machine is downloading public pods in a different way than your colleague’s machine. This can happen due to two possible reasons. Either your CDN (content delivery network) source is named differently than your teammate’s or you are using a different source all together.

Example: Source Name Mismatch

Teammate A commits new work which installed pods from the CDN source, named “trunk” on their machine. The new work is pulled down by teammate B and they sync up their local pods. Teammate B’s machine also has the CDN source but it is named “cocoapods-” on their machine. The diff occurs because the source names don’t match even though the pods and source location are the same.

cocoapod image 2

With Cocoapods 1.8+, the primary source for public pod downloads is the CDN (https://cdn.cocoapods.org/). Prior to 1.8, the primary source was hosted on GitHub (https://github.com/CocoaPods/Specs.git).

If you are seeing a 1-line diff whenever you run pod install, it is possible that:

  • Your spec repo source is the correct CDN, but the source is named something different than your colleague’s source (i.e. “cocoapods-” vs. “trunk”)
  • You are pulling public pods from the legacy public repo: https://github.com/CocoaPods/Specs.git (likely named “master”)

Solution

In the terminal, run:

user$ pod repo list

If you see “master” (mapped to the legacy source) or “cocoapods-” (mapped to the CDN) in your repo list you can remove them using:

user$ pod repo remove <repo_name>

The next time you run pod install you should not see any diff on Podfile.lock.

Note: Each member of the team should check their environment and update accordingly. Otherwise, you might still see source/naming diffs. Double check any changes to Podfile.lock during code reviews to catch this before it is merged.

Example
user$ pod repo list

master
- Type: git (master)
- URL:  https://github.com/CocoaPods/Specs.git
- Path: /Users/name/.cocoapods/repos/master

cocoapods- 
- Type: CDN
- URL:  https://cdn.cocoapods.org/
- Path: /Users/name/.cocoapods/repos/trunk

2 repos
user$ pod repo remove master
Removing spec repo `master`
user$ pod repo remove cocoapods-
Removing spec repo `cocoapods-`
user$ pod install
...
Pod installation complete! ...
user$ pod repo list

trunk
- Type: CDN
- URL:  https://cdn.cocoapods.org/
- Path: /Users/name/.cocoapods/repos/trunk
1 repo

I know from experience that it can be frustrating to deal with this. I hope this has provided some help to you and your team!

More Information

For more information on Podfile.lock, visit the Cocoapod Guide for Podfile.lock. Sequence Diagram made using https://sequencediagram.org/. Diff image via Visual Studio Code - https://code.visualstudio.com/

Join our team to work with Fortune 500 companies in solving real-world product strategy, design, and technical problems.

Find Your Role

App Clips: A New Gateway for Users to Experience

Image Source: Apple Over 9 years ago, Apple introduced the phrase, “There's an...

Read the article