Getting started with Xcode Cloud
A quick start guide to getting your project set up with Xcode Cloud for continuous integration, development, and distribution.
Overview
Xcode Cloud is a continuous integration and delivery (CI/CD) system that combines the tools you use to create apps and frameworks for Apple platforms.
To onboard your project with Xcode Cloud, you:
Select your app or framework.
Decide on your first workflow.
Connect your Git repository to Xcode Cloud.
Create an app record if necessary.
Start your first build.
After adding your project to Xcode Cloud, you can customize your configuration as needed for your specific development and distribution needs.
For more information, see Setting up your project to use Xcode Cloud and Configuring your first Xcode Cloud workflow.
Before you begin
Before you start using Xcode Cloud, you need to:
Be a member of the Apple Developer Program. For information on joining the Developer program, see Distributing your app for beta testing and releases.
Add your account to Xcode in Apple Accounts settings.
Ensure that your app has a unique bundle identifier.
Have permissions to do create an app record or create an app record yourself in App Store Connect (see Add a new app).
Have a remote Git repository with admin access.
Push your latest project changes to the remote repository.
[Image]
Configure Xcode Cloud for your project
To use Xcode Cloud with your project:
Open your project in Xcode.
In the Report navigator, click the Cloud tab.
Click the Get Started button that appears below.
[Image]
Add your project to Xcode Cloud
In the sheet that appears after clicking Get Started, find your app or framework:
Select your app or framework from the list that Xcode detects.
Select the team for the app or framework, if it isn’t already selected.
Click Next.
[Image]
Review the suggested workflow
In the next sheet, Xcode shows you a default workflow that:
Starts a build on every change to your main branch.
Uses the latest macOS and Xcode versions.
Archives your app or framework.
To accept the default workflow, click Next. Otherwise, click Edit Workflow.
[Image]
For more information on choosing start conditions, see Configuring start conditions.
Grant Xcode Cloud access to your Git repository
Grant access to your git repository to allow Xcode Cloud to automatically build and test your code when you make changes:
Click Grant Access.
In the browser window that appears, follow the instructions to authorize Xcode Cloud access to your Git repository.
If necessary, sign in to your App Store Connect account and follow the steps that appear.
Follow the instructions in the browser to finish granting access to your Git repository.
In Xcode, click Next to add your project’s Git repository to Xcode Cloud.
[Image]
For Git repository-specific instructions, see Source code management setup.
Create an app record
Xcode Cloud uses an existing app record that matches your bundle identifier, if available. Otherwise, Xcode Cloud creates a new app record for you.
In the Create App on App Store Connect dialog that appears:
Verify that the app name and bundle identifier are correct.
Enter a SKU and choose a primary language.
Click Complete.
[Image]
Start your first build
Now let Xcode Cloud build your app or framework as the final onboarding step.
In the Start Build dialog, confirm the branch that you want Xcode Cloud to build your project from.
Click Start Build.
[Image]
Next steps
View the progress of your build in the Report navigator.
If necessary, click the Cloud tab.
To customize the workflow, Control-click your app or framework and choose Manage Workflows (Integrate > Manage Worflows).
If you encounter build issues, see Resolving common configuration and build issues for tips.
[Image]
Similarly, you can view builds and manage workflows in App Store Connect if you prefer.