Is the project.xcworkspace file important?

Question

I am doing command line xcodebuild using a shell script. My problem is if I open and close the xx.xcodeproj file once and then use that command it works well.

Somehow if I get deep into the file changes, this project.xcworkspace is the only file that has changed. Is this file valid and should I check it into version control? Will this cause any issues?

I've heard that it's as important as .pbxproj: is this true?

I couldn't find any valid documentation which talks about the roles and responsibilities of various files in the xcode project files. Please provide links which help me to understand that.

Answer 1

project.xcworkspace is a directory of files describing the workspace or projects. Although some of the answers here indicate it is unnecessary and should be ignored for source control, I don't agree, but it's going to be highly dependent upon how you use your environment. Generally, the contents of the project.xcworkspace directory contains the contents.xcworkspacedata file, which lists the projects that are included as top-level entities in your project, an xcuserdata directory, which contains each user's settings (should be ignored for source code controL), and xcshareddata, which is data shared by users who share a project, and should be under source control.

In environments where you don't share workspaces, or where you use simple workspaces, you can ignore these as well, however in environments where you put related projects in the same workspace and share that configuration, you may well want to keep these.

Answer 2

I don't think project.xcworkspace in xx.xcodeproj is important. And it has nothing to do with Cocoapods.

If you create a workspace named x.xcworkspace, create a project named y.xcodeproj and add the project to x.xcworkspace at the same time; then you will find that there is no project.xcworkspace is created under y.xcodeproj directory.

However, if you open y.xcodeproj with Xcode, project.xcworkspace is automatically created by Xcode.