smartappsaustralia/sfdx

SmartDX

镜像概述和主要用途

SmartDX是Smartapps生态系统中的专用工具，用于将Smartapps SmartDX集成到项目中，支持Salesforce项目的配置管理、自动化部署及验证流程。目前仅适用于Smartapps生态系统内的项目，其他项目如需集成，请联系管理员。

核心功能和特性

• 支持SFDX项目文件配置修改，包括packageDirectories设置
• 提供环境变量管理，适配不同部署环境（生产、测试等）
• 集成OpenSSL工具，支持密钥解密操作
• 支持通过JWT认证方式连接Salesforce Dev Hub
• 自动化Scratch Org创建、代码推送及删除流程
• 适配CI/CD流水线，支持默认验证、拉取请求验证及分支部署

使用场景和适用范围

• Smartapps生态系统内的Salesforce项目开发
• 项目的自动化构建与验证（如Scratch Org验证、PR验证）
• 生产环境与测试环境的自动化部署
• 需要通过SFDX工具链管理Salesforce元数据的场景

详细使用方法和配置说明

自安装步骤

需修改的项目文件

sfdx-proj.json

在项目文件中添加{"path":"smartdx", "default":false}配置：

json
// 示例：
{
  "packageDirectories": [
    {
      "path": "force-app",
      "default": true
    },
    {
      "path": "smartdx",
      "default": false
    }
  ],
  "namespace": "",
  "sfdcLoginUrl": "https://login.salesforce.com",
  "sourceApiVersion": "48.0"
}

.gitignore

添加server.key以避免将解密后的密钥上传到在线仓库。

.forceignore

添加smartdx/certificates以在部署时忽略该目录。

添加仓库变量

[!注意] 可能需要为不同自动部署环境添加类似变量。例如：$SMARTDX_TEST_CONSUMER_KEY是测试环境中安装的Connected App消费者密钥，$SMARTDX_TEST_USER是测试环境中部署用户的用户名。

示例YAML文件

yml
image: smartappsaustralia/sfdx:latest

pipelines:
  default:
    - step:
        name: Scratch Org Validation
        script:
          # 测试Docker镜像
          - sfdx force --help
          # 检查OpenSSL安装
          - openssl version
          # 解密密钥
          - openssl aes-256-cbc -md sha512 -pbkdf2 -iter 100000 -salt -k "$SMARTDX_KEY" -in "$SMARTDX_ENCRYPTED_KEY" -out server.key -d
          # 通过JWT认证Dev Hub
          - sfdx force:auth:jwt:grant -u "$SMARTDX_PROD_USER" -f server.key -i "$SMARTDX_PROD_CONSUMER_KEY" -r "$SMARTDX_PROD_INSTANCE_URL" -a prod
          # 创建Scratch Org并推送源代码
          - sfdx force:org:create -f config/project-scratch-def.json -a scratchTest -d 1 -v prod --json --loglevel fatal
          # 推送sfdx-project.json中Package Directories指定的源文件
          - sfdx force:source:push -u scratchTest --loglevel fatal
          # 删除Scratch Org
          - sfdx force:org:delete -u scratchTest --noprompt
  pull-requests: # 除非另有指定，否则这些命令对所有分支运行
    "**/**":
      - step:
          name: PR Validation
          script:
            # 测试Docker镜像
            - sfdx force --help
            # 检查OpenSSL安装
            - openssl version
            # 解密密钥
            - openssl aes-256-cbc -md sha512 -pbkdf2 -iter 100000 -salt -k "$SMARTDX_KEY" -in "$SMARTDX_ENCRYPTED_KEY" -out server.key -d
            # 通过JWT认证Dev Hub
            - sfdx force:auth:jwt:grant -u "$SMARTDX_PROD_USER" -f server.key -i "$SMARTDX_PROD_CONSUMER_KEY" -r "$SMARTDX_PROD_INSTANCE_URL" -a prod
            # 创建Scratch Org并推送源代码
            - sfdx force:org:create -f config/project-scratch-def.json -a scratchTest -d 1 -v prod --json --loglevel fatal
            # 推送sfdx-project.json中Package Directories指定的源文件
            - sfdx force:source:push -u scratchTest --loglevel fatal
            # 删除Scratch Org
            - sfdx force:org:delete -u scratchTest --noprompt
  branches:
    develop:
      - step:
          name: 在指定分支推送时部署到沙箱
          script:
            # 解密密钥
            - openssl aes-256-cbc -md sha512 -pbkdf2 -iter 100000 -salt -k "$SMARTDX_KEY" -in "$SMARTDX_ENCRYPTED_KEY" -out server.key -d
            # 认证测试环境沙箱
            # - sfdx force:auth:jwt:grant -u "$SMARTDX_TEST_USER" -f server.key -i "$SMARTDX_TEST_CONSUMER_KEY" -r "$SMARTDX_TEST_INSTANCE_URL" -a test
            # 在测试环境沙箱部署并运行测试
            # - sfdx force:source:deploy -p force-app -u $SMARTDX_TEST_USER -l RunLocalTests -u test -w 60 --verbose --json

管理员联系方式

• Sneh Malpani
• Nikhil Sharma
• Anurag Malpani

当前SFDX版本

版本号：7.65.4-c99e705754