You are here:
Set Up Your GitHub Project Repositories
A GitHub repository (sometimes called a repo for short) stores project work files — code, text, images, and so on. Each DevOps Center project needs its own repository for storing project changes. While you’re working on the project, the repository is the team’s centralized source of truth to manage changes.
DevOps Center can be used only with GitHub.com Cloud-based plans, including GitHub Enterprise Cloud. All users must have their own cloud-based GitHub.com account to work in this version of DevOps Center. Locally hosted versions of GitHub, including GitHub Enterprise Server, aren’t currently supported. We’ve designed DevOps Center to eventually integrate with multiple third-party source control systems, such as Bitbucket (in beta), GitLab, and other GitHub versions.
Communication Protocols
DevOps Center uses the GitHub REST API for all communications to and from GitHub.
DevOps Center uses the OAuth 2.0 open protocol to establish access to both your GitHub repository (hosted by GitHub) and your work environments (hosted by Salesforce). OAuth allows you to delegate a client application (DevOps Center) to access data from a protected resource (your project repository, for example) through the exchange of tokens, instead of exchanging security credentials. For details, see Authorize Apps with OAuth in Salesforce Help.
Create a GitHub Account
If you already have a GitHub account, great! If you don’t have a GitHub account yet, it’s easy (and free) to sign up for one.
New to GitHub or to Source Control?
We’ve designed DevOps Center to make it easy to take advantage of a source control system like GitHub even if you aren’t yet familiar with it. If you want to learn more about Git and GitHub concepts and terminology as you dive in to using DevOps Center, look at the Git and GitHub Basics Trailhead module (estimated time: less than two hours), which covers why source control is so key to successful team collaboration and what to expect in a typical GitHub workflow.
Methods to Create GitHub Project Repositories
A DevOps Center project repository must contain a Salesforce DX project. You can create a DevOps Center project repository using any of these methods:
- When you create your project within DevOps Center, let it create a Github repository that uses the Salesforce DX project structure. Skip to Manage Environments.
- Use an existing Github repository.
- Create a different GitHub repository.
Create a New Repository
Creating a repository from our template ensures that the repository has the right structure and configuration to work with DevOps Center, that is, the structure and configuration of a Salesforce DX project.
If you don’t already have a source control repo, a corresponding project repository with the proper DX structure is created when you define a DevOps Center project. Alternately, you can log in to GitHub and use the repository template at https://github.com/forcedotcom/dx-empty to create your project repository. Your project repository can be either public or private. You don’t need to include all branches. For details about how to create a repository from a template, see the GitHub help.
After the repository is created, you can seed it by adding metadata files from your production org or another source org.
