capgemdx

v1.3.0

Published

2 years ago

SFDX DevOps Orchestrator

Downloads

845

0High
0Medium
0Low

bernardw888

sfdx-plugin

capgemdx

SFDX DevOps Orchestrator

Facilitates the scratch org creation
Facilites project deployment for CICD
Deploy delta changes
ETL datasets

                                                  <!-- install -->

You'll be prompted that this, like any plugin, is not officially code-signed by Salesforce. Continue installation

$ npm install -g capgemdx
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
capgemdx/1.3.0 win32-x64 node-v16.13.1
$ sfdx --help [COMMAND]
USAGE
  $ sfdx COMMAND
...

Install plugin via SFDX

sfdx plugins:install capgemdx

Create a new folder named "gemconfig" to your sfdx project root directory

Add the following configuration files

gemconfig.json

orgmetadatafilepath: holding folder path for processing metadata files
outputdatafilepath: holding folder path for processing data files
manualprompt: boolean value indicating whether a manual prompt is required pre-scratchorg deployments
filesignore: folder or files to ignore when performing branch diff e.g. { "orgmetadatafilepath": "./mdapioutput/orgmetadata/", "outputdatafilepath": "./mdapioutput/data/", "logfile": "./mdapioutput/log/capgemdx.log", "logsize": 102400, "manualprompt": "false", "diffRenameLimit": "10000", "packageWaitTime": 30, "apiversion": "50.0", "filesignore": [ "data/", "scripts/", "config/", "decommissioned/", "force-app/unused/", "jsconfig.json", ".eslintrc.json", "devops/", ".forceignore", ".gitignore", "sfdx-project.json", "gemconfig/*", ".vim-force.com/session.properties", "**.DS_Store" ], "diffsuppressfolders": [], "branching": [ "prototype-", "develop-", "feature-" ] }

gemscoconfig.json: configuration specific to scratch org

forceignore: array of relative paths to metadata files to include in .forceignore, include \n for newline
postscratchorgcreate: operation to be executed post scratch org create, accepts operation list, see acceptable operation lists
predeployment: operation to be executed pre-deployment, accepts operation list, see acceptable operation lists
postdeployment: operation to be executed post deployment, accepts operation list, see acceptable operation lists
postcleanup: cleanup activities before termination of process
e.g. Copy the following json and save in gemscoconfig.json { "forceignore": [ "\n#STARTIGNORE", "\n#ENDIGNORE" ], "postscratchorgcreate": [ { "type": "command", "value": [ "sfdx force:org:open", "sfdx force:data:record:update -s User -w "Name='User User'" -v "UserPermissionsKnowledgeUser=true"" ] }, { "type": "api", "method": "POST", "url": "/services/data/v50.0/sobjects/OrgWideEmailAddress", "body": { "Address": "[email protected]", "DisplayName": "displayname", "IsAllowAllProfiles": true } } ], "predeployment": [ { "type": "package", "name": "Salesforce.com CRM Dashboards", "packageid": "04t50000000EcdrAAC" } ], "prepush": [ { "type":"replace", "from": "test-[A-Za-z0-9@.\-]@example.com", "to": "s#test-[A-Za-z0-9@.\-]@example.com#$username#g", "path": ["./force-app/main/default/"] } ], "postdeployment": [ { "type":"command", "value": [ "sfdx force:user:permset:assign --permsetname Manage_Encryption_Keys", "value": "sfdx force:user:permset:assign --permsetname Apex_Debugger" ] } ], "postcleanup": [ { "type":"replace", "from": "test-[A-Za-z0-9@.\-]@example.com", "to": "[email protected]", "path": [ "force-app/main/default/settings/Case.settings-meta.xml", "./force-app/main/default/reports/" ] } ] }

gemsandboxconfig.json: configuration specific to sandbox

forceignore: array of relative paths to metadata files to include in .forceignore, include \n for newline
predeployment: operation to be executed pre-deployment, accepts operation list, see acceptable operation lists
postdeployment: operation to be executed post deployment, accepts operation list, see acceptable operation lists
postcleanup: cleanup activities before termination of process

gemprodconfig.json: configuration specific to production

forceignore: array of relative paths to metadata files to include in .forceignore, include \n for newline
predeployment: operation to be executed pre-deployment, accepts operation list, see acceptable operation lists
postdeployment: operation to be executed post deployment, accepts operation list, see acceptable operation lists
postcleanup: cleanup activities before termination of process

Configuration Operation list:

command: any acceptable line command e.g.

{
    "type":"command",
    "value": "sfdx force:user:permset:assign --permsetname Manage_Encryption_Keys"
}

replace: find and replace operation e.g.

{
    "type":"replace",
    "from": "<name>test-[A-Za-z0-9@.\\-]*@example.com</name>",
    "to": "s#<name>test-[A-Za-z0-9@.\\-]*@example.com</name>#<name>$username<name>#g",
    "path":["./force-app/base-objects/main/default/"]
}

api: api callout operation e.g.

{
    "type": "api",
    "method": "POST",
    "url": "/services/data/v50.0/sobjects/OrgWideEmailAddress",
    "body": {
        "Address": "[email protected]",
        "DisplayName": "displayname",
        "IsAllowAllProfiles": true
    }
}

package: appexchange package installation e.g.

{
    "type": "package",
    "name": "Salesforce.com CRM Dashboards",
    "packageid": "04t50000000EcdrAAC"
}