gauravtrivedi/node-sfdx-cli

docker-sfdx-cli 镜像文档

镜像概述和主要用途

docker-sfdx-cli是专为SFDX项目设计的Docker镜像，旨在提供Salesforce开发CI/CD流程所需的完整工具链和环境前置条件，简化开发团队在持续集成/持续部署过程中的环境配置工作。

核心功能和特性

• Commitlint：支持语义化提交规范，帮助团队标准化Git提交日志，提升代码变更文档的可读性
• SFDX CLI：完整安装Salesforce命令行工具，提供Salesforce开发全流程的命令支持
• SFDX扫描器：集成静态代码分析功能，可对代码进行质量检查和漏洞扫描
• Jest：包含LWC（Lightning Web Components）测试工具，支持组件单元测试
• 基础环境：基于OpenJDK构建，内置Node.js，可直接使用npm或yarn管理项目依赖

使用场景和适用范围

适用于各类Salesforce项目的CI/CD流程，包括但不限于：

• 代码提交阶段的语义化规范检查
• 静态代码质量分析与安全扫描
• LWC组件的自动化单元测试
• 集成到CI/CD管道（如Jenkins、GitHub Actions、GitLab CI等）
• 开发环境一致性保障

详细使用方法和配置说明

镜像获取

从Docker Hub拉取最新镜像：

bash
docker pull gauravtrivedi/node-sfdx-cli

基本使用示例

运行容器并进入交互式终端：

bash
docker run -it --rm gauravtrivedi/node-sfdx-cli /bin/bash

在CI/CD管道中使用

GitHub Actions示例

yaml
jobs:
  sfdx-pipeline:
    runs-on: ubuntu-latest
    steps:
      - name: 检出代码
        uses: actions/checkout@v4
      
      - name: 执行SFDX命令
        uses: docker://gauravtrivedi/node-sfdx-cli
        with:
          args: |
            sfdx force:auth:jwt:grant -u ${{ secrets.ORG_USERNAME }} -f server.key -i ${{ secrets.CLIENT_ID }} -d
            sfdx force:source:deploy -p force-app/main/default
            sfdx force:apex:test:run -c -r human

GitLab CI示例

yaml
stages:
  - deploy

sfdx-deploy:
  stage: deploy
  image: gauravtrivedi/node-sfdx-cli
  script:
    - sfdx force:auth:jwt:grant -u $ORG_USERNAME -f server.key -i $CLIENT_ID -d
    - sfdx force:source:deploy -p force-app/main/default

环境使用说明

• Node.js环境：可直接执行npm或yarn命令管理依赖

  bash
  # 安装项目依赖
  npm install
  
  # 或使用yarn
  yarn install
  

• Commitlint使用：在项目中配置commitlint规则后，可通过以下命令检查提交信息

  bash
  commitlint --from HEAD~1 --to HEAD
  

• SFDX扫描器使用：执行静态代码分析

  bash
  sfdx scanner:run --target "force-app/**/*.cls" --format xml --outfile scan-results.xml
  

镜像信息

• Docker Hub地址：https://hub.docker.com/r/gauravtrivedi/node-sfdx-cli/
• 自动化构建状态：