Skip to content

Latest commit

 

History

History
90 lines (53 loc) · 6.88 KB

README.md

File metadata and controls

90 lines (53 loc) · 6.88 KB
Raw

sfdx-gitlab-org

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.

This repository shows how to successfully set up deploying to non-scratch orgs (sandbox or production) with GitLab CI/CD. We make a few assumptions in this README. Continue only if you have completed these critical configuration prerequisites.

Getting Started

  1. Mirror this repo in to your GitLab account.

  2. Clone your mirrored repo locally: git clone https://gitlab.com/<gitlab_username>/sfdx-gitlab-org.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, download and install it from here.

  4. Setup 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 to the target orgs: sfdx auth:jwt:grant --clientid <your_consumer_key> --jwtkeyfile server.key --username <your_username>

    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. IMPORTANT! For security reasons, don't store the server.key within the project.

  • First, generate a key and initializtion vector (iv) to encrypt your server.key file locally. The key and iv are used by AppVeyor 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.

  • Encrypt the server.key using the newly generated key and iv values. Use the key and iv values only once. Don't use them to encrypt more than the server.key. While you can re-use this pair to encrypt other things, it's considered a security violation to do so. Every time you run the command above, it generates a new key and iv value. You can't regenerate the same pair. If you lose these values, generated new ones and encrypt again.
openssl enc -nosalt -aes-256-cbc -in your_key_location/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 values somewhere safe. You'll use these values in a subsequent step in the GitLab UI. These values are considered secret so please treat them as such.

  1. From your JWT-based connected app on Salesforce, retrieve the generated Consumer Key and store it in an AppVeyor environment variable named CONSUMER_KEY using the AppVeyor UI.

  2. Set up GitLab CI/CD environment variables for your Salesforce Consumer Key and Username. Note that this username is the username that you use to access your Salesforce org.

    Create an environment variable named CONSUMER_KEY and set it as protected.

    Create an environment variable named USER_NAME and set it as protected.

    Create an environment variable named ENDPOINT and set it as protected.

    Note - this is the endpoint that you use to log in to your target org (e.g. login.salesforce.com).

    Note: Setting the variables as protected requires that you set the branch to protected as well.

  3. Set up GitLab CI/CD environment variable The key and iv used to encrypt your server.key file.

    Create an environment variable named DECRYPTION_KEY and set it as protected.

    Create an environment variable named DECRYPTION_IV and set it as protected.

    Note: Setting the variables as protected requires that you set the branch to protected as well.

Now you're ready to go! Wwhen you commit and push a change, your change kicks off a GitLab CI build.

Enjoy!

Environment Variables

Env Var Description
CONSUMER_KEY From your JWT-based connected app on Salesforce, retrieve the generated Consumer Key from your Dev Hub org.
USER_NAME This username is the username that you use to access your Dev Hub.
ENDPOINT the login URL of the instance the org lives on.
DECRYPTION_KEY server.key encryption key.
DECRYPTION_IV server.key encryption initialization Vector.
DX_CLI_URL_CUSTOM By default, the script installs the current version of Salesforce CLI. To install the release candidate, set the DX_CLI_URL_CUSTOM local variable to the appropriate URL.

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.