sfdx-bamboo-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.
This repository shows one way you can successfully use scratch orgs to create new package versions with Bamboo. 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 Bamboo. (Need help? See the Bamboo Getting Started guide.)
- You have properly set up the JWT-based authorization flow (headless). We recommended using these steps for generating your self-signed SSL certificate.
Getting Started
-
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. -
Fork this repo to your GitHub account using the fork link at the top of the page.
-
Clone your forked repo locally:
git clone https://github.com/<git_username>/sfdx-bamboo-package.git
-
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) -
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.
-
From your JWT-based connected app on Salesforce, retrieve the generated
Consumer Key
. -
Set up Bamboo plan variables for your Salesforce
Consumer Key
andUsername
. Note that this username is the username that you use to access your Salesforce org.Create a plan variable named
CONSUMER_KEY
.Create a plan variable named
USER_NAME
. -
Encrypt and store the generated
server.key
. IMPORTANT! For security reasons, don't store theserver.key
within the project.
- First, generate a key and initializtion vector (iv) to encrypt your
server.key
file locally. Thekey
andiv
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
andiv
values output to the screen. You'll use the values followingkey=
andiv =
to encrypt yourserver.key
.
- Encrypt the
server.key
using the newly generatedkey
andiv
values. Use thekey
andiv
values only once. Don't use them to encrypt more than theserver.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 newkey
andiv
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
, andiv
values somewhere safe. You'll use these values in a subsequent step in the AppVeyor UI. These values are considered secret so please treat them as such.
-
Set up Bamboo plan variable for the
key
andiv
you used to encrypt yourserver.key
file.Create a plan variable named
DECRYPTION_KEY
. Create a plan variable namedDECRYPTION_IV
. -
Copy all the contents of
package-sfdx-project.json
intosfdx-project.json
and save. -
Create the sample package.
sfdx force:package:create --path force-app/main/default/ --name "Bamboo" --description "Bamboo Package Example" --packagetype Unlocked
-
Create the first package version.
sfdx force:package:version:create --package "Bamboo" --installationkeybypass --wait 10 --json --targetdevhubusername HubOrg
-
In the
build.sh
orbuild.bat
file, update the value in thePACKAGENAME
variable to be the Package ID in yoursfdx-project.json
file. This ID starts with0Ho
. -
Commit the updated
sfdx-project.json
andbuild.sh
files. -
Create a Bamboo plan with the build file for your operating system (
build.bat
for Windows andbuild.sh
for all others). The build files are included in the root directory of the Git repository. -
If you're on Windows, install jq. Make sure the
jq
executable is on the path.
https://stedolan.github.io/jq/download/
Now you're ready to go! When you commit and push a change, your change kicks off a Bamboo 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.