ozanbotanls / sfdx-circleci-package

Circle CI examples with package development

sfdx-circleci-package

For a fully guided walkthrough of setting up and configuring continuous integration using scratch orgs and Salesforce CLI, see the Continuous Integration Using Salesforce DX Trailhead module using Travis CI.

This repository shows one way you can successfully use Salesforce CLI to create new package versions with CircleCI. We make a few assumptions in this README. Continue only if you have completed these critical configuration prerequisites.

• You know how to set up your Github repository with CircleCI. (Here's their Getting Started guide.)
• You have properly set up the JWT-based authorization flow (headless). We recommend using these steps for generating your Self-Signed SSL Certificate.

Getting Started

1. Fork this repo in to your GitHub account using the fork link at the top of the page.

2. Clone your forked repo locally: git clone https://github.com/<git_username>/sfdx-circleci-package.git

3. Make sure that you have Salesforce CLI installed. Run sfdx force --help and confirm you see the command output. If you don't have it installed, you can download and install it from here.

4. Set up a JWT-based auth flow for the target orgs that you want to deploy to. This step creates a server.key file that is used in subsequent steps. (https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_auth_jwt_flow.htm)

5. Confirm that you can perform a JWT-based auth: sfdx force:auth:jwt:grant --clientid <your_consumer_key> --jwtkeyfile server.key --username <your_username> --setdefaultdevhubusername

   Note: For more info on setting up JWT-based auth, see Authorize an Org Using the JWT-Based Flow in the Salesforce DX Developer Guide.

6. Encrypt and store the generated server.key using the instructions below. IMPORTANT! For security reasons, don't store the server.key within the project.

"CircleCI does a nice job of allowing you to set environment variables inside the UI in a protected way." (attribution to Kevin O'Hara)

• First, generate a key and initializtion vector (iv) to encrypt your server.key file locally. CircleCI uses the key and iv to decrypt your server key in the build environment.

$ openssl enc -aes-256-cbc -k <passphrase here> -P -md sha1 -nosalt
  key=E5E9FA1BA31ECD1AE84F75CAAA474F3A663F05F412028F81DA65D26EE56424B2
  iv =E93DA465B309C53FEC5FF93C9637DA58

Make note of the key and iv values output to the screen. You'll use the values following key= and iv = to encrypt your server.key in the next step.

• Encrypt the server.key using the newly generated key and iv values. The key and iv values should only be used once, don't use them to encrypt more than the server.key. While you can re-use this pair to encrypt other things, it is considered a security violation to do so. Every time you run the command above, a new key and iv value will be generated. IE, you can not regenerated the same pair, so if you lose these values you will need to generated new ones and encrypt again.

openssl enc -nosalt -aes-256-cbc -in assets/server.key -out assets/server.key.enc -base64 -K <key from above> -iv <iv from above>

This command replaces the existing server.key.enc with your encrypted version.

• Store the key, and iv as protected environment variables in the CircleCI UI. These valus are considered secret so please treat them as such.

7. From your JWT-based connected app on Salesforce, retrieve the generated Consumer Key from your Dev Hub org.

8. Set your Consumer Key in a CircleCI environment variable named HUB_CONSUMER_KEY using the CircleCI UI. Set your Username in a CircleCI environment variable named HUB_USER_NAME using the CircleCI UI. This username is the username that you use to access your Dev Hub.

9. Store the key and iv values used above in CircleCI environment variables named DECRYPTION_KEY and DECRYPTION_IV, respectively. When finished setting environment variables, your environment variables setup screen should look like the one below.

10. Copy all the contents of package-sfdx-project.json into sfdx-project.json and save.

11. Create the sample package. Run: sfdx force:package:create --path force-app/main/default/ --name "CircleCI" --description "Circle CI Package Example" --packagetype Unlocked

12. Create the first package version: sfdx force:package:version:create --package "CircleCI" --installationkeybypass --wait 10 --json --targetdevhubusername HubOrg

13. In the config.yml, update the value in the PACKAGENAME variable to be the Package Id in your sfdx-project.json file. This ID starts with 0Ho.

14. Commit the updated sfdx-project.json,config.yml, and server.key.enc files.

Now you're ready to go! When you commit and push a change, your change kicks off a CircleCI build.

Enjoy!

Contributing to the Repository

If you find any issues or opportunities for improving this repository, fix them! Feel free to contribute to this project by forking this repository and making changes to the content. Once you've made your changes, share them back 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.