SFDX - Converting an existing Salesforce production org to DX and Github in 4 steps

Converting an existing Salesforce production org to SFDX and Github.md

Converting an existing Salesforce production org to SFDX and Github

0. Prerequisites

SFDX

• You need SFDX installed locally on your computer :
  https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_install_cli.htm
• You need an SFDX dev hub :
  • https://altius.my.salesforce.com for DCE projects
  • the customer's production org with Dev Hub enabled :
    https://help.salesforce.com/articleView?id=sfdx_setup_enable_devhub.htm&type=0
• You need an account on that Dev Hub with a "Salesforce Limited Access - Free" license (or more) : https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_add_users.htm
• Log in to the Dev Hub with SFDX :

  sfdx force:auth:web:login -a devhub -d

Github

• You need a GitHub account; log in to your Github account
• In Github, fork the sample repository and declare it as a template : https://github.com/AltiusRupert/sfdx-sample
• Download the Github desktop application : https://desktop.github.com

1. Create a new Github repo

• Use the sample
• Create the new repo
• Sync the repo locally : this folder should be for PROD only, and will use the master branch

2. Prepare the package.xml

• Go to https://packagebuilder.herokuapp.com
• Log in to the target Salesforce production environment
• Select "Component Option" = "Wildcard Only"
• Click "Get Components"
• Copy the text displayed
• Copy it into the local file in manifest/package.xml

3. Get source code from production

# This logs in, creates an alias and declares this user as the default use
# Replace <clientname> with the client's name
 
sfdx force:auth:web:login -a <clientname>-prod -s
sfdx force:source:retrieve -u <clientname>-prod -x manifest/package.xml

4. Commit source code to Github repo

• In VSCode, go to the Source Control tab : it confirms that source control = Git
• Declare the Github remote repo : in VSCode, open command palette and choose "Git: Add Remote". Call it 'origin' and entre the url of the Github repo, including your username and password, eg

https://username:[email protected]/<username>/<repo>
ex : https://AltiusRupert:[email protected]/AltiusRupert/client-SPIT

• Commit all code files with comment "initial commit" : this commits files locally
• Sync to Github : click on the Sync icon next to "master" in the Source Control tab and sync will start
• At the end of the sync, check the results in Github : the force-app/main/default folder has been populated.