Salesforce DX Developer Guide

How Salesforce Developer Experience Changes the Way You Work
Enable Dev Hub Features in Your Org
Project Setup
Authorization
Metadata Coverage
Scratch Orgs
Sandboxes
Track Changes Between Your Project and Org
Development
Build and Release Your App
First-Generation Managed Packages
Second-Generation Managed Packages
Partner Licensing Platform (Developer Preview)
Unlocked Packages
Continuous Integration
Continuous Integration Using CircleCI
Configure Your Environment for CircleCI
Connect CircleCI to Your DevHub
Continuous Integration Using Jenkins
Continuous Integration with Travis CI
Sample CI Repos for Org Development Model
Sample CI Repos for Package Development Model
Troubleshoot Salesforce DX
Limitations for Salesforce DX
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Connect CircleCI to Your DevHub

Authorize CircleCI to push content to your Dev Hub via a connected app.
  1. Make sure that you have Salesforce CLI installed. Check by running sfdx force --help and confirm that you see the command output. If you don't have it installed, see Install Salesforce CLI.
  2. Confirm you can perform a JWT-based authorization from the directory containing your server.key file. Run the following command from the directory containing your server.key (replace <your_consumer_key> and <your_username> values where indicated). 
    1sfdx auth:jwt:grant --clientid <your_consumer_key> --jwtkeyfile server.key --username <your_username> --setdefaultdevhubusername
  3. Fork the sfdx-circleci repo into your GitHub account using the Fork link at the top of the page.
  4. Create a local directory for this project and clone your forked repo locally into the new directory. Replace <git_username> with your own GitHub username. 
    1git clone https://github.com/<git_username>/sfdx-circleci.git
  5. Retrieve the generated consumer key from your JWT-Based Authorization connected app. From Setup, in the Quick Find box, enter App, and then select App Manager. Select View in the row-menu next to the connected app.
  6. In the CircleCI UI, you see a project named sfdx-circleci. In the project settings, store the consumer key in a CircleCI environment variable named HUB_CONSUMER_KEY. For more information, see the CircleCI documentation Setting an Environment Variable in a Project.
  7. Store the username that you use to access your Dev Hub in a CircleCI environment variable named HUB_SFDX_USER using the CircleCI UI.
  8. Store the key and iv values from Encrypt Your Server Key in CircleCI environment variables named DECRYPTION_KEYand DECRYPTION_IV, respectively. When you finish setting the environment variables, your project screen looks like the following image.
    CircleCI project environment variables example.

    In the directory containing your server.key file, use the command rm server.key to remove the server.key. Never store keys or certificates in a public place.

    Note

You’re ready to go! Now when you commit and push a change, your change kicks off a CircleCI build.

Contributing to the Repository

If you find any issues or opportunities for improving this repository, fix them! Feel free to contribute to this project, fork this repository, and then change the content. After you make your changes, share them with the community by sending a pull request. See How to send pull requests for more information about contributing to GitHub projects.

Reporting Issues

If you find any issues with this demo that you can't fix, feel free to report them in the issues section of this repository.