Using Git with an existing Xcode project

Question

I am trying to figure out how to use git in my project workflow, and I have an existing Xcode project that I want to put into the repository. I think I have the repository set up correctly under organizer, but the Source Control menu is grayed out.
Apparently, it's easy to do if you start a new project, but how do I import an existing project with snapshots and everything?

I'm using Xcode 4 and git 1.7.4

Also, if there are any good walkthroughs on git configuration and best practices, that would be nice. I'm a little late to the game, so anything that can get me up to speed would be cool.

score 181 · Accepted Answer · edited Oct 03 '15 at 10:56

181

GitHub has some very good git tutorials at help.github.com.

to do the initial setup of a repository, open up a terminal window, and CD to the project directory. once there, type

git init
git add .
git commit -m "Initial commit"

Restart Xcode. The repository should now be set up, and you will be able to manage it in xcode 4.

edited Oct 03 '15 at 10:56

Vatsal Manot

17,695
9
44
80

answered Mar 21 '11 at 21:04

MCannon

4,011
2
16
12

5

Where is the bit about adding a .gitignore file to avoid adding all build directories and other crap as tracked files ??? – Fraggle Oct 12 '12 at 12:56
8

This method would add .xcuserstate and other metadata to the repo, which should not be version-controlled. I'd suggest that you first create .gitignore in your project folder and list those metadata file types before you run "git add .". – kakyo Jun 19 '13 at 22:43
Did not work for me at all. Xcode never recognises it as a repo. – Jonny Jul 18 '15 at 17:00
1

I'm using Xcode 11. I was able to add a local git repository to an existing project simply by doing Source Control, Commit and then doing my first commit. That created the .git folder, etc. (No need for the `git init`, `git add .` and `git commit -m`.) – Jeff Jul 22 '20 at 06:30
In Xcode 14 you can add git to an existing project by selecting: Source Control > New Git Repository... > Create – P. Stern Nov 13 '22 at 02:00

score 113 · Answer 2 · edited Jun 20 '20 at 09:12

Xcode 7 (and 8)

If you were starting a new project you would just check Create Git repository during the setup. (Then skip down to the Commit part below.)

But it you are working with an existing project, go to Xcode > Preferences... > Source Control and check the Enable Source Control box.

Then in the main Source Control menu choose Create Working Copy....

(If you get a "Please tell me who you are" error the see this question/answer or one of the other linked questions there.)

When that has finished, make any change to one of your Xcode project files. Then go back to the Source Control menu and choose Commit.

And write a commit message and click the Commit button. (If the commit button is disabled, then make any minor change to your project and try again.)

In Github sign in and create a new repository.

Call it whatever you want, but don't add a README or .gitignore or license yet. You can add those things later. Doing so now will make the syncing more difficult.

Copy the link to your repository.

Go to Source Control > your branch name > Configure.

Click the Remotes tab > "+" button > Add remote....

Enter the github repository name and paste in the address.

After adding the remote, click Push in the Source Control menu. Enter your github user name and password. That's it. You project should be copied to github now.

(I had some trouble getting my username and password accepted at first. If that happens to you go to Xcode > Preferences... > Accounts > your new repository. Enter your user name and password there and then try the Push again.)

You can add a README and other files, but if you do it from the web, you will have to do Source Control > Pull in Xcode before you con commit other changes.

Now any time you make changes in Xcode, all you have to do is Commit and Push.

I learned this method mostly from here.

this is the easiest solution by far. can u tell me what it means when u add a repo in xcode>preferences>accounts>add repo ? — AceN, Sep 30 '15 at 07:35
@AceNeerav, This allows you to store your credentials for another repo that you have so that you don't have to enter them every time. See [this documentation](https://developer.apple.com/library/ios/recipes/xcode_help-accounts_preferences/articles/add_repository.html) for more details. — Suragch, Sep 30 '15 at 12:25
Great solution. TIP: Bitbucket is a free alternative to github for small projects. You pay once the project gets big. — steve-o, Nov 08 '16 at 17:17
@steve-o, [GitLab](https://about.gitlab.com/) is also a good alternative. It allows private repositories for free. I was able to configure Xcode to use it similarly to my answer above. — Suragch, Nov 09 '16 at 00:12
thanks by following url answer i m able to do it myself thanks a lot once again — Dilip Tiwari, Jul 27 '18 at 05:27
This has changed quite a bit in recent years. For example, the default branch is now main and the UI for Xcode 12 looks quite a bit different. — Jeff Muir, May 03 '21 at 05:55

score 44 · Answer 3 · answered May 30 '13 at 16:50

44

I just went through the process of doing this for several projects, and ran into some issues. Here was my process, mostly pieced together from the other answers on this page/site. Order is very important here

Open terminal and cd into the directory containing the .xcodeproj file
git init
In finder enter the newly created .git folder (in the same directory as the .xcodeproj file). Find info/exclude, open and add these lines, .DS_Store and xcuserdata/
Not sure if this is needed, but I used terminal to cp info/exclude over to a .gitignore file
git add .
git commit -m "Initial commit"
Now to get XCode to actually see the repo. In the project organizer, you first have to delete the project from the Projects tab. Then simply re-open the project to get it back. This will detect the GIT repository just created
In the repositories tab of the organizer I then branch off the master branch/switch into whatever version I'm working on.

Hopefully this helps someone without being too redundant. What now seems simple was definitely a challenge for someone new to GIT with existing projects

answered May 30 '13 at 16:50

nuclearnova

785
7
10

2

Thanks for sharing your experience! The step by step is great. – AndyD273 Jun 03 '13 at 12:49
Great step by step, very helpful for someone like me who isn't comfortable with git yet. – Nicolas Miari Jun 06 '13 at 04:28
1

For me, with 4.6.2, step 7 wasn't necessary. Thanks! – cloudsurfin Jul 19 '13 at 21:16
I cannot explain how helpful this was! step 7 helped even with latest Xcode! – Zephyer Jul 23 '13 at 12:36
As I learnt following the above steps and some other posts and svn experience. You can create .gitignore file for Xcode. List if items to ignore can be found on GitHub https://github.com/github/gitignore/blob/master/Global/Xcode.gitignore – Bhavesh Mar 22 '14 at 23:31
Even doing step 7 did not help for me. – Jonny Jul 18 '15 at 16:49

score 10 · Answer 4 · edited May 23 '17 at 10:31

10

Check out my post on this topic Setting up a git repository in XCode for a pre-existing project. The above is correct, but it will include UserInterfaceState in your changes as you commit and this could be annoying because this file updates everytime you do anything in xcode, even if it is as simple and navigating through files or folders in your project.

edited May 23 '17 at 10:31

Community

1
1

answered Jun 13 '12 at 19:45

Joey

1,144
3
15
29

score 1 · Answer 5 · answered Sep 19 '15 at 00:13

1

if your XCODE 7 is not connecting with existing GIT repository. Try following

xcrun git config --global user.email your@email.com
xcrun git config --global user.name "your name"

answered Sep 19 '15 at 00:13

Ram G.

3,045
2
25
31

score 1 · Answer 6 · answered Apr 25 '22 at 19:10

Newer versions of Xcode simplify adding git to an existing Xcode project. Open your project in Xcode and choose Source Code > New Git Repositories. A sheet opens.

Select the checkbox next to the project and click the Create button to add git to the project.

score 0 · Answer 7 · answered Jul 31 '19 at 09:42

Note:Specially for Xcode 11

CD to project directory using terminal

git init

git add .

git commit -m "Initial commit"

After this restart the Xcode and choose Source Control Navigator and then select the master and right click then choose option "Create Remote"

Using Git with an existing Xcode project

7 Answers7

Xcode 7 (and 8)

See also

Linked

Related