持续集成 （CI） 是一种软件开发实践，开发人员在其中 定期将他们的代码更改集成到源代码存储库中。确保新代码 不引入错误，自动构建和测试在开发人员签入之前或之后运行 变化。

许多第三方 CI 工具可供您选择。Salesforce DX 轻松集成 添加到这些工具中，以便您可以为 Salesforce 设置持续集成 应用。

• 使用 CircleCI 进行持续集成 CircleCI
  是一种常用的集成工具，它与您现有的版本控制系统集成，以将增量更新推送到您指定的环境。CircleCI 可以用作基于云的或本地工具。这些说明演示了如何使用 GitHub、CircleCI 和 Dev Hub 组织进行持续集成。
• 使用 Jenkins 进行持续集成
  Jenkins 是一个开源的、可扩展的自动化服务器，用于实现持续集成和持续交付。您可以轻松地将 Salesforce DX 集成到 Jenkins 框架中，以针对临时组织自动测试 Salesforce 应用程序。
• 与 Travis CI 的持续集成
  Travis CI 是一种基于云的持续集成 （CI） 服务，用于构建和测试 GitHub 上托管的软件项目。
• 组织开发模型
  的示例 CI 存储库 通过从您选择的供应商处克隆示例存储库，快速开始使用 CI。每个存储库都有一个示例配置文件和一个包含分步信息的综合 README.md。
• 包开发模型
  的示例 CI 存储库 通过克隆所选供应商的示例存储库，快速开始使用 CI。每个存储库都有一个示例配置文件和一个包含分步信息的综合 README.md。

使用 CircleCI 进行持续集成

CircleCI 是一种常用的集成工具，可与您现有的集成 版本控制系统，用于将增量更新推送到您指定的环境。CircleCI系列 可用作基于云的或本地工具。这些说明演示了如何使用 GitHub、CircleCI 和 Dev Hub 组织，用于持续集成。

• 为 CircleCI 配置环境
  在集成现有 CircleCI 框架之前，请配置开发人员中心组织和 CircleCI 项目。
• 将 CircleCI 连接到您的 DevHub
  授权 CircleCI 通过连接的应用程序将内容推送到您的 Dev Hub。

为 CircleCI 配置环境

在集成现有的 CircleCI 框架之前，请配置开发人员中心组织和 CircleCI 项目。

1. 使用 CircleCI 设置 GitHub 存储库。您可以按照 CircleCI 网站上的注册步骤访问您的代码 在 GitHub 上。
2. 安装 Salesforce CLI（如果您还没有）。
3. 如果尚未操作，请遵循使用 JWT 流为 Dev Hub 组织授权组织。
4. 加密服务器密钥。
   1. 首先，生成密钥和初始化向量 （iv） 以在本地加密 server.key 文件。CircleCI 使用 key 和 iv 来 在生成环境中解密服务器密钥。在包含 server.key 文件的目录中运行以下命令。 对于值，请输入您自己选择的单词 以创建唯一密钥。<passphrase>openssl enc -aes-256-cbc -k <passphrase> -P -md sha1 -nosalt键和 iv 值显示在输出中。key=****24B2 iv =****DA58
   2. 请注意 key 和 iv 值，稍后需要用到它们。
   3. 使用新生成的密钥加密 server.key 文件，然后 IV 值。在包含 server.key 文件的目录中运行以下命令，将 <key> 和 <iv> 替换为上一步中的值。openssl enc -nosalt -aes-256-cbc -in server.key -out server.key.enc -base64 -K <key> -iv <iv>注意key 和 iv 值仅使用一次，并且不要使用它们来加密超过 server.key 的值。虽然您可以重复使用此对来加密其他 事情，这样做被视为违反安全规定。每次在步骤 a 中运行命令时，都会生成新的键和 iv 值。在 换句话说，你不能重新生成同一对。如果丢失这些值，则必须 生成新的并再次加密。

接下来，将 server.key.enc 的密钥、iv 和内容存储为 CircleCI UI 中受保护的环境变量。这些值被认为是机密的，因此 采取适当的预防措施来保护它们。

将 CircleCI 连接到您的 DevHub

授权 CircleCI 通过连接的应用程序将内容推送到您的开发人员中心。

1. 确保您已安装 Salesforce CLI。通过运行 sf version 进行检查，并确认您看到的是版本信息。如果你 未安装，请参阅安装 Salesforce CLI。
2. 确认您可以从包含 server.key 文件的目录中执行基于 JWT 的授权。从包含 您的 server.key（替换 <your_consumer_key> 并在指示的位置<your_username>值）。sf org login jwt --client-id <your_consumer_key> --jwt-key-file server.key --username <your_username> --set-default-dev-hub
3. 使用页面顶部的 Fork 链接将 sfdx-circleci 存储库分叉到你的 GitHub 帐户中。
4. 为此项目创建一个本地目录，并将分叉的存储库本地克隆到新的 目录。将 <git_username> 替换为你自己的 GitHub 用户名。git clone https://github.com/<git_username>/sfdx-circleci.git
5. 从基于 JWT 的授权连接的应用中检索生成的使用者密钥。从 设置，在“快速查找”框中，输入“应用”，然后选择“应用” 经理。在已连接旁边的行菜单中选择查看 应用程序。
6. 在 CircleCI UI 中，您会看到一个名为 sfdx-circleci 的项目。在项目设置中，存储 名为 HUB_CONSUMER_KEY 的 CircleCI 环境变量中的使用者密钥。有关更多信息，请参阅 CircleCI 文档在 项目。
7. 将用于访问 Dev Hub 的用户名存储在 CircleCI 环境变量中 使用 CircleCI UI 命名HUB_SFDX_USER。
8. 将加密服务器密钥中的密钥和 iv 值存储在 CircleCI 环境变量中 分别命名为 DECRYPTION_KEY和 DECRYPTION_IV。完成环境变量的设置后，您的 项目屏幕如下图所示。注意在包含 server.key 文件的目录中，使用命令删除 server.key。切勿在公共场所存放密钥或证书。rm server.key

你准备好了！现在，当您提交并推送更改时，您的更改将启动一个 CircleCI 构建。

为存储库做贡献

如果您发现任何问题或改进此存储库的机会，请修复它们！随意 为这个项目做贡献，分叉这个仓库，然后将 内容。进行更改后，通过发送拉取请求与社区共享这些更改。 有关参与的详细信息，请参阅如何发送拉取请求 到 GitHub 项目。

报告问题

如果您发现此演示中有任何问题无法修复，请随时在此存储库的问题部分报告。

使用 Jenkins 进行持续集成

Jenkins 是一个开源的、可扩展的自动化服务器，用于实现连续 集成和持续交付。您可以轻松地将 Salesforce DX 集成到 Jenkins 中 框架，用于针对临时组织自动测试 Salesforce 应用程序。

为了集成 Jenkins，我们假设：

• 您熟悉 Jenkins 的工作原理。您可以通过多种方式配置和使用 Jenkins。我们 专注于将 Salesforce DX 集成到 Jenkins 多分支管道中。
• 运行 Jenkins 服务器的计算机有权访问版本控制 系统和包含 Salesforce 应用程序的存储库。

• 为 Jenkins 配置环境
  在将 Dev Hub 和临时组织集成到现有 Jenkins 框架之前，请配置 Jenkins 环境。我们的示例假定你使用的是包开发模型。
• Jenkinsfile 演练
  示例 Jenkinsfile 演示如何将 Dev Hub 和临时组织集成到 Jenkins 作业中。此示例使用 Jenkins 多分支管道。每个 Jenkins 设置都是不同的。本演练介绍自动测试 Salesforce 应用程序的方法之一。本演练重点介绍了用于创建临时组织、上传代码和运行测试的 Salesforce CLI 命令。
• 示例 Jenkinsfile
  Jenkinsfile 是一个文本文件，其中包含 Jenkins Pipeline 的定义。此 Jenkinsfile 展示了如何集成 Salesforce CLI 命令，以使用 scratch 组织自动测试 Salesforce 应用程序。

为 Jenkins 配置环境

在将 Dev Hub 和 Scratch 组织集成到现有的 Jenkins 框架之前， 配置 Jenkins 环境。我们的示例假定你正在包中工作 发展模式。

1. 在开发人员中心组织中，按照基于 JWT 的授权流所述创建连接的应用。此步骤包括获取或创建私钥和数字证书。在保存连接的 应用程序。您需要使用者密钥来设置 Jenkins 环境。也有可用的 用于对数字证书进行签名的私钥文件。
2. 在运行 Jenkins 服务器的计算机上，执行以下操作。
   1. 下载并安装 Salesforce CLI。
   2. 使用 Jenkins 管理员凭据将私钥文件存储为 Jenkins 机密文件 接口。记下新条目的 ID。稍后在 Jenkinsfile 中引用此凭据条目。
   3. 在 Jenkins 环境中设置以下变量。
      • SF_USERNAME – Dev Hub 组织的用户名，例如 juliet.capulet@myenvhub.com。
      • SF_INSTANCE_URL – 托管 Dev Hub 的 Salesforce 实例的登录 URL 组织。默认值为 https://login.salesforce.com。我们建议您更新 此值设置为 Dev Hub 组织的 My Domain 登录 URL。您可以找到一个组织的 “设置”中“我的域”页面上的“我的域”登录 URL。
      • SF_CONSUMER_KEY – 创建连接后返回的使用者密钥 开发人员中心组织中的应用。
      • SERVER_KEY_CREDENTALS_ID – 您的私钥文件的凭证 ID 存储在 Jenkins 管理员凭据界面中。
      • PACKAGE_NAME – 包的名称，例如“我的包”。
      • PACKAGE_VERSION-软件包的版本，以 04t 开头。
      • TEST_LEVEL – 包的测试级别，例如 RunLocalTests。
      这些环境变量的名称只是建议。您可以使用任何名称作为 只要你在 Jenkinsfile 中指定它。您还可以选择设置SF_AUTOUPDATE_DISABLE 变量以禁用 Salesforce 命令行界面。CLI 自动更新可能会干扰 Jenkins 的执行 工作。true
3. 设置您的 Salesforce DX 项目，以便您可以创建临时组织。
4. （可选）将自定义工具插件安装到 Jenkins 控制台中，并创建一个自定义 引用 Salesforce CLI 的工具。Jenkins 演练假定您创建了一个 /usr/local/bin 目录中名为 toolbelt 的自定义工具，该目录是 Salesforce CLI 的安装目录。

Jenkinsfile 演练

示例 Jenkinsfile 展示了如何将 Dev Hub 和 Scratch 组织集成到 Jenkins 作业。此示例使用 Jenkins 多分支管道。每个 Jenkins 设置都是 不同。本演练介绍自动测试 Salesforce 的方法之一 应用。本演练重点介绍了用于创建临时组织的 Salesforce CLI 命令。 上传代码并运行测试。

本演练依赖于 sfdx-jenkins-package Jenkinsfile。我们假设你熟悉 Jenkinsfile、Jenkins Pipeline DSL 和 Groovy 编程语言的结构。这 演练演示如何使用 Salesforce CLI 实现 Jenkins 管道，以及 临时组织。有关所使用的命令，请参阅 CLI 命令参考。

此工作流与 Jenkinsfile 阶段最接近。

• 定义变量
• 查看源代码
• 将所有阶段包装在 withCredentials 命令中
• 将所有阶段包装在 withEnv 命令中
• 授权 Dev Hub 组织并创建临时组织
• 推送源并分配权限集
• 运行 Apex 测试
• 删除临时组织
• 创建程序包
• 创建临时组织并显示信息
• 安装包、运行单元测试和删除临时组织

定义变量

使用关键字定义所需的变量 通过 Salesforce CLI 命令。为每个变量分配相应的环境变量 您之前在 Jenkins 环境中设置。def

def SF_CONSUMER_KEY=env.SF_CONSUMER_KEY
def SERVER_KEY_CREDENTALS_ID=env.SERVER_KEY_CREDENTALS_ID
def TEST_LEVEL='RunLocalTests'
def PACKAGE_NAME='0Ho1U000000CaUzSAK'
def PACKAGE_VERSION
def SF_INSTANCE_URL = env.SF_INSTANCE_URL ?: "https://MyDomainName.my.salesforce.com"

定义变量，但不要设置其 价值。你稍后再做。SF_USERNAME

def SF_USERNAME

虽然不是必需的，但我们假设你使用 Jenkins 全局工具配置来 创建指向 CLI 安装目录。在 Jenkinsfile 中，使用 tool 命令将变量的值设置为此自定义工具。toolbelttoolbelt

def toolbelt = tool 'toolbelt'

现在，您可以使用 在 Jenkinsfile 中引用 Salesforce CLI 可执行文件。${toolbelt}/sf

查看源代码

在测试代码之前，请从版本控制中获取相应的版本或分支 系统 （VCS） 存储库。在此示例中，我们使用 Jenkins 命令。我们假设 Jenkins 管理员已经 配置环境以访问正确的 VCS 存储库并检出正确的 分支。checkout scm

stage('checkout source') {
        // when running in multi-branch job, one must issue this command
        checkout scm
  }

将所有阶段包装在 withCredentials 命令中

您之前使用 凭据接口。因此，您必须使用 Jenkinsfile 正文中的命令来访问机密文件。该命令允许您命名凭据条目，然后 从凭据存储中提取，并通过变量提供给包含的代码。 使用时，将所有阶段放在其 代码块。withCredentialswithCredentialswithCredentials

此示例将 JWT 密钥文件的凭据 ID 存储在变量 中。您之前定义了 并将其设置为其 相应的环境变量。该命令从以下位置获取密钥文件的内容 凭据存储并将内容放置在临时位置。位置 存储在变量 中。你 将变量与命令一起使用以指定 私钥安全。SERVER_KEY_CREDENTALS_IDSERVER_KEY_CREDENTALS_IDwithCredentialsserver_key_fileserver_key_fileorg login jwt

withCredentials([file(credentialsId: SERVER_KEY_CREDENTALS_ID, variable: 'server_key_file')])
   # all stages will go here 
}

将所有阶段包装在 withEnv 命令中

运行 Jenkins 作业时，了解文件的存储位置会很有帮助。那里 是需要注意的两个主要目录：工作区目录和主页 目录。工作区目录对于每个作业都是唯一的，而主目录是 所有工作都一样。

该命令将 JWT 密钥文件存储在 作业期间的 Jenkins 工作区。但是，Salesforce CLI 命令将身份验证文件存储在主目录中;这些 身份验证文件在作业持续时间之外保留。withCredentialsauth

运行单个作业时，此设置不会出现问题，但在运行时可能会导致问题 多个作业。因此，如果使用同一个 Dev Hub 运行多个作业，会发生什么情况，或者 其他 Salesforce 用户？当 CLI 尝试以用户身份连接到开发人员中心时，你 经过身份验证时，无法刷新令牌。为什么？CLI 尝试使用 JWT 密钥 其他工作区中不再存在的文件，而不考虑当前作业。withCredentials

如果使用 设置主目录以匹配工作区目录，则每个作业的身份验证文件都是唯一的。 为每个作业创建唯一的身份验证文件也更安全，因为每个作业只能访问 它创建的身份验证文件。withEnv

使用 时，将所有阶段都放在其代码中 块withEnv

withEnv(["HOME=${env.WORKSPACE}"]) {
   # all stages will go here 
}

注意

如果不使用管道或在管道阶段之外运行命令，请添加主页 脚本的环境规范：。export HOME=$WORKSPACE

授权 Dev Hub 组织并创建临时组织

此示例使用两个 阶段：一个阶段用于授权开发人员中心组织，另一个阶段用于创建临时 组织。sfdx-jenkins-package

// -------------------------------------------------------------------------
// Authorize the Dev Hub org with JWT key and give it an alias.
// -------------------------------------------------------------------------

stage('Authorize DevHub') {   
    rc = command "${toolbelt}/sf org login jwt --instance-url ${SF_INSTANCE_URL} --client-id ${SF_CONSUMER_KEY} --username ${SF_USERNAME} --jwt-key-file ${server_key_file} --set-default-dev-hub --alias HubOrg"
    if (rc != 0) {
        error 'Salesforce dev hub org authorization failed.'
    }
}


// -------------------------------------------------------------------------
// Create new scratch org to test your code.
// -------------------------------------------------------------------------

stage('Create Test Scratch Org') {
    rc = command "${toolbelt}/sf org create scratch --target-dev-hub HubOrg --set-default --definition-file config/project-scratch-def.json --alias ciorg --wait 10 --duration-days 1"
    if (rc != 0) {
        error 'Salesforce test scratch org creation failed.'
    }
}

用于授权开发人员中心组织。org login jwt

此步骤只需运行一次，但我们建议您将其添加到 Jenkinsfile 中，并在每次授权时进行授权 运行 Jenkins 作业。这样，您始终可以确保 Jenkins 作业不会中止 由于缺乏授权。授权多个通常没有什么坏处 时间，但请记住，临时组织版本的API调用限制仍然存在 适用。

使用命令的标志 提供有关你正在授权的开发人员中心组织的信息。的值 、 和 标志是 SF_CONSUMER_KEY、HubOrg 和 SF_INSTANCE_URL 环境变量 之前分别定义。标志的值是您在上一节中使用 命令。该标志指定此 HubOrg 是用于创建临时组织的默认 Dev Hub 组织。org login jwt–client-id–username–instance-url–jwt-key-fileserver_key_filewithCredentials–set-default-dev-hub

注意

最佳做法是为每个 Jenkins 作业提供唯一的身份验证文件 使用包装器。但这是可能的 改为在 Jenkins 计算机上授权 Dev Hub。优点是你的 在计算机上为运行的任何 Jenkins 作业集中设置身份验证。这 缺点是安全性：每个作业都可以访问所有经过身份验证的用户，无论 你希望他们或不愿意。withEnv

如果确实要在 Jenkins 上对 Dev Hub 进行身份验证If you do want to auth to auth to your Dev Hub on your Jenkins 机器，请按照下列步骤操作：

• 在 Jenkins 计算机上，以 Jenkins 用户身份，使用 任何命令。org login
• 在 Jenkinsfile 中，删除 、 、 和语句。withCredentialswithEnvorg login jwt

使用 CLI 命令创建 一个临时组织。在此示例中，CLI 命令使用 config/project-scratch-def.json 文件（相对于 项目目录）以创建临时组织。该标志将输出指定为 JSON 格式。该标志将新的临时组织设置为 违约。org create scratch–json–set-default

解析命令的 JSON 输出的 Groovy 代码提取自动生成的用户名 组织创建的一部分。使用此用户名，存储在 SF_USERNAME 变量中，用于 使用推送源、分配权限集等的 CLI 命令。org create scratch

推送源并分配权限集

让我们用元数据填充您的新临时组织。此示例使用命令部署源 到组织。源代码包括构成 Salesforce 的所有部分 application：Apex 类和测试类、权限集、布局、触发器、 自定义对象等。project deploy start

// -------------------------------------------------------------------------
// Push source to test scratch org.
// -------------------------------------------------------------------------

stage('Push To Test Scratch Org') {
    rc = command "${toolbelt}/sf project deploy start --target-org ciorg"
    if (rc != 0) {
        error 'Salesforce push to test scratch org failed.'
    }
}

回想一下包含输出的自动生成的用户名的 SF_USERNAME 变量 通过前面的命令 阶段。该代码使用此变量作为标志的参数，以指定 新的 Scratch 组织。org create scratch–target-org

该命令将部署所有 它在项目中找到的与 Salesforce 相关的文件。将 .forceignore 文件添加到存储库以列出 您不希望推送到组织的文件。project deploy start

运行 Apex 测试

现在，您的源代码和测试源代码已推送到临时组织，请运行命令以运行 Apex 测试。apex run test

// -------------------------------------------------------------------------
// Run unit tests in test scratch org.
// -------------------------------------------------------------------------

stage('Run Tests In Test Scratch Org') {
    rc = command "${toolbelt}/sf apex run test --target-org ciorg --wait 10 --result-format tap --code-coverage --test-level ${TEST_LEVEL}"
    if (rc != 0) {
        error 'Salesforce unit test run in test scratch org failed.'
    }
}

您可以为 CLI 指定各种标志 命令。在示例中：apex run test

• 该标志运行所有测试 在临时组织中，源自已安装的托管软件包的测试除外。 您还可以指定运行 仅本地测试，运行 仅某些 Apex 测试或套件，或运行组织中的所有测试。–test-level ${TEST_LEVEL}RunLocalTestsRunSpecifiedTestsRunAllTestsInOrg
• 该标志指定 命令输出采用 Test Anything Protocol （TAP） 格式。测试结果 写入文件仍采用 JUnit 和 JSON 格式。–result-format tap
• 该标志指定用户名 用于访问 Scratch 组织（SF_USERNAME 中的值）。–target-org ciorg

该命令将其测试结果写入 JUnit 格式。apex run test

删除临时组织

Salesforce 保留在临时文件后指定天数内删除临时组织的权利 已创建。您还可以在管道中创建一个阶段，用于显式删除 测试完成后的 scratch 组织。此清理可确保更好地管理您的 资源。org delete scratch

// -------------------------------------------------------------------------
// Delete package install scratch org.
// -------------------------------------------------------------------------

stage('Delete Package Install Scratch Org') {
    rc = command "${toolbelt}/sf org delete scratch --target-org installorg --no-prompt"
    if (rc != 0) {
        error 'Salesforce package install scratch org deletion failed.'
    }
}

创建程序包

现在，让我们创建一个包。如果您不熟悉包装，则可以将包装视为 使用元数据填充的容器。它包含一组相关功能， 自定义项和架构。您可以使用包将元数据从一个 Salesforce 组织移动到 另一个。创建包后，添加元数据并创建新的包版本。

// -------------------------------------------------------------------------
// Create package version.
// -------------------------------------------------------------------------

stage('Create Package Version') {
    if (isUnix()) {
        output = sh returnStdout: true, script: "${toolbelt}/sf package version create --package ${PACKAGE_NAME} --installation-key-bypass --wait 10 --json --target-dev-hub HubOrg"
    } else {
        output = bat(returnStdout: true, script: "${toolbelt}/sf package version create --package ${PACKAGE_NAME} --installation-key-bypass --wait 10 --json --target-dev-hub HubOrg").trim()
        output = output.readLines().drop(1).join(" ")
}

    // Wait 5 minutes for package replication.
    sleep 300

    def jsonSlurper = new JsonSlurperClassic()
    def response = jsonSlurper.parseText(output)

    PACKAGE_VERSION = response.result.SubscriberPackageVersionId

    response = null

    echo ${PACKAGE_VERSION}
}

创建临时组织并显示信息

还记得您之前创建临时组织的时候吗？现在让我们创建一个临时组织进行安装 您的包，并显示有关该暂存组织的信息。

// -------------------------------------------------------------------------
// Create new scratch org to install package to.
// -------------------------------------------------------------------------

stage('Create Package Install Scratch Org') {
    rc = command "${toolbelt}/sf org create scratch --target-dev-hub HubOrg --set-default --definition-file config/project-scratch-def.json --alias installorg --wait 10 --duration-days 1"
    if (rc != 0) {
        error 'Salesforce package install scratch org creation failed.'
    }
}


// -------------------------------------------------------------------------
// Display install scratch org info.
// -------------------------------------------------------------------------

stage('Display Install Scratch Org') {
    rc = command "${toolbelt}/sf org display --target-org installorg"
    if (rc != 0) {
        error 'Salesforce install scratch org display failed.'
    }
}

安装包、运行单元测试和删除临时组织

最后，在临时组织中安装软件包，运行单元测试，然后删除 scratch org. 就是这样！

// -------------------------------------------------------------------------
// Install package in scratch org.
// -------------------------------------------------------------------------

stage('Install Package In Scratch Org') {
    rc = command "${toolbelt}/sf package install --package ${PACKAGE_VERSION} --target-org installorg --wait 10"
    if (rc != 0) {
        error 'Salesforce package install failed.'
    }
}


// -------------------------------------------------------------------------
// Run unit tests in package install scratch org.
// -------------------------------------------------------------------------

stage('Run Tests In Package Install Scratch Org') {
    rc = command "${toolbelt}/sf apex run test --target-org installorg --result-format tap --code-coverage --test-level ${TEST_LEVEL} --wait 10"
    if (rc != 0) {
        error 'Salesforce unit test run in pacakge install scratch org failed.'
    }
}


// -------------------------------------------------------------------------
// Delete package install scratch org.
// -------------------------------------------------------------------------

stage('Delete Package Install Scratch Org') {
    rc = command "${toolbelt}/sf org delete scratch --target-org installorg --no-prompt"
    if (rc != 0) {
        error 'Salesforce package install scratch org deletion failed.'
    }
}

示例 Jenkinsfile

Jenkinsfile 是一个文本文件，其中包含 Jenkins 流水线的定义。此 Jenkinsfile 展示了如何集成 Salesforce CLI 命令以自动测试 Salesforce 使用 Scratch 组织的应用程序。

Jenkinsfile 演练主题使用此 sfdx-jenkins-package Jenkinsfile 作为示例。

#!groovy

import groovy.json.JsonSlurperClassic

node {

    def SF_CONSUMER_KEY=env.SF_CONSUMER_KEY
    def SF_USERNAME=env.SF_USERNAME
    def SERVER_KEY_CREDENTALS_ID=env.SERVER_KEY_CREDENTALS_ID
    def TEST_LEVEL='RunLocalTests'
    def PACKAGE_NAME='0Ho1U000000CaUzSAK'
    def PACKAGE_VERSION
    def SF_INSTANCE_URL = env.SF_INSTANCE_URL ?: "https://login.salesforce.com"

    def toolbelt = tool 'toolbelt'


    // -------------------------------------------------------------------------
    // Check out code from source control.
    // -------------------------------------------------------------------------

    stage('checkout source') {
        checkout scm
    }


    // -------------------------------------------------------------------------
    // Run all the enclosed stages with access to the Salesforce
    // JWT key credentials.
    // -------------------------------------------------------------------------
    
    withEnv(["HOME=${env.WORKSPACE}"]) {
        
        withCredentials([file(credentialsId: SERVER_KEY_CREDENTALS_ID, variable: 'server_key_file')]) {

            // -------------------------------------------------------------------------
            // Authorize the Dev Hub org with JWT key and give it an alias.
            // -------------------------------------------------------------------------

            stage('Authorize DevHub') {
                rc = command "${toolbelt}/sf org login jwt --instance-url ${SF_INSTANCE_URL} --client-id ${SF_CONSUMER_KEY} --username ${SF_USERNAME} --jwt-key-file ${server_key_file} --set-default-dev-hub --alias HubOrg"
                if (rc != 0) {
                    error 'Salesforce dev hub org authorization failed.'
                }
            }


            // -------------------------------------------------------------------------
            // Create new scratch org to test your code.
            // -------------------------------------------------------------------------

            stage('Create Test Scratch Org') {
                rc = command "${toolbelt}/sf org create scratch --target-dev-hub HubOrg --set-default --definition-file config/project-scratch-def.json --alias ciorg --wait 10 --duration-days 1"
                if (rc != 0) {
                    error 'Salesforce test scratch org creation failed.'
                }
            }


            // -------------------------------------------------------------------------
            // Display test scratch org info.
            // -------------------------------------------------------------------------

            stage('Display Test Scratch Org') {
                rc = command "${toolbelt}/sf org display --target-org ciorg"
                if (rc != 0) {
                    error 'Salesforce test scratch org display failed.'
                }
            }


            // -------------------------------------------------------------------------
            // Push source to test scratch org.
            // -------------------------------------------------------------------------

            stage('Push To Test Scratch Org') {
                rc = command "${toolbelt}/sf project deploy start --target-org ciorg"
                if (rc != 0) {
                    error 'Salesforce push to test scratch org failed.'
                }
            }


            // -------------------------------------------------------------------------
            // Run unit tests in test scratch org.
            // -------------------------------------------------------------------------

            stage('Run Tests In Test Scratch Org') {
                rc = command "${toolbelt}/sf apex run test --target-org ciorg --wait 10 --result-format tap --code-coverage --test-level ${TEST_LEVEL}"
                if (rc != 0) {
                    error 'Salesforce unit test run in test scratch org failed.'
                }
            }


            // -------------------------------------------------------------------------
            // Delete test scratch org.
            // -------------------------------------------------------------------------

            stage('Delete Test Scratch Org') {
                rc = command "${toolbelt}/sf org delete scratch --target-org installorg --no-prompt"
                if (rc != 0) {
                    error 'Salesforce test scratch org deletion failed.'
                }
            }


            // -------------------------------------------------------------------------
            // Create package version.
            // -------------------------------------------------------------------------

            stage('Create Package Version') {
                if (isUnix()) {
                    output = sh returnStdout: true, script: "${toolbelt}/sf package version create --package ${PACKAGE_NAME} --installation-key-bypass --wait 10 --json --target-dev-hub HubOrg"
                } else {
                    output = bat(returnStdout: true, script: "${toolbelt}/sf package version create --package ${PACKAGE_NAME} --installation-key-bypass --wait 10 --json --target-dev-hub HubOrg").trim()
                    output = output.readLines().drop(1).join(" ")
                }

                // Wait 5 minutes for package replication.
                sleep 300

                def jsonSlurper = new JsonSlurperClassic()
                def response = jsonSlurper.parseText(output)

                PACKAGE_VERSION = response.result.SubscriberPackageVersionId

                response = null

                echo ${PACKAGE_VERSION}
            }


            // -------------------------------------------------------------------------
            // Create new scratch org to install package to.
            // -------------------------------------------------------------------------

            stage('Create Package Install Scratch Org') {
                rc = command "${toolbelt}/sf org create scratch --target-dev-hub HubOrg --set-default --definition-file config/project-scratch-def.json --alias installorg --wait 10 --duration-days 1"
                if (rc != 0) {
                    error 'Salesforce package install scratch org creation failed.'
                }
            }


            // -------------------------------------------------------------------------
            // Display install scratch org info.
            // -------------------------------------------------------------------------

            stage('Display Install Scratch Org') {
                rc = command "${toolbelt}/sf org display --target-org installorg"
                if (rc != 0) {
                    error 'Salesforce install scratch org display failed.'
                }
            }


            // -------------------------------------------------------------------------
            // Install package in scratch org.
            // -------------------------------------------------------------------------

            stage('Install Package In Scratch Org') {
                rc = command "${toolbelt}/sf package install --package ${PACKAGE_VERSION} --target-org installorg --wait 10"
                if (rc != 0) {
                    error 'Salesforce package install failed.'
                }
            }


            // -------------------------------------------------------------------------
            // Run unit tests in package install scratch org.
            // -------------------------------------------------------------------------

            stage('Run Tests In Package Install Scratch Org') {
                rc = command "${toolbelt}/sf apex run test --target-org installorg --result-format tap --code-coverage --test-level ${TEST_LEVEL} --wait 10"
                if (rc != 0) {
                    error 'Salesforce unit test run in pacakge install scratch org failed.'
                }
            }


            // -------------------------------------------------------------------------
            // Delete package install scratch org.
            // -------------------------------------------------------------------------

            stage('Delete Package Install Scratch Org') {
                rc = command "${toolbelt}/sf org delete scratch --target-org installorg --no-prompt"
                if (rc != 0) {
                    error 'Salesforce package install scratch org deletion failed.'
                }
            }
        }
    }
}

def command(script) {
    if (isUnix()) {
        return sh(returnStatus: true, script: script);
    } else {
        return bat(returnStatus: true, script: script);
    }
}

与 Travis CI 的持续集成

Travis CI 是一种基于云的持续集成 （CI） 服务，用于构建和测试托管在 GitHub 上的软件项目。

有关设置 Travis CI 的帮助，请参阅：

• 组织开发模型的示例 Travis CI 存储库
• 包开发模型的示例 Travis CI 存储库

组织开发模型的示例 CI 存储库

通过从您选择的供应商处克隆示例存储库，快速开始使用 CI。 每个存储库都有一个示例配置文件和一个全面的 README.md 分步信息。

这些示例存储库支持组织开发模型。此模型使用 Salesforce CLI、 源代码管理系统和应用程序生命周期中的沙盒。要确定这是否 模型适合您，请完成组织开发模型模块，赢取徽章。

包开发模型的示例 CI 存储库

通过从您选择的供应商处克隆示例存储库，快速开始使用 CI。 每个存储库都有一个示例配置文件和一个全面的 README.md 分步信息。

这些示例存储库支持包开发模型。此模型使用 Salesforce CLI、源代码控制系统、用于开发的临时组织以及用于测试和 分期。要确定此型号是否适合您，请前往并通过以下方式获得徽章 完成包开发模型模块。

Salesforce DX 疑难解答

以下是一些帮助您解决问题的提示。

• CLI 版本信息 使用这些命令可查看有关 Salesforce CLI 的版本信息
  。
• 错误：未找到
  默认开发中心 由于授权问题，当您尝试创建临时组织时，您会看到此错误。
• 组织授权失败后无法工作
  有时，您尝试使用 Salesforce CLI 或 IDE 授权 Dev Hub 组织或临时组织，但未成功登录到该组织。端口对于杂散授权过程保持打开状态，并且您不能使用 CLI 或 IDE。若要继续，请手动结束该过程。
• 错误：使用者密钥已被获取
  假设你在已创建连接应用的组织上运行。当您尝试将检索到的源部署到其他组织时，部署失败并显示错误。发生了什么事？project retrieve startThe consumer key is already taken

CLI 版本信息

使用以下命令可查看有关 Salesforce CLI 的版本信息。

sf plugins --core      // Version of the CLI and all installed plug-ins
sf --version     // CLI version

错误：未找到默认开发中心

当您尝试创建临时组织时，由于授权问题，您会看到此错误。

假设你使用该标志成功授权了开发人员中心组织。与组织关联的用户名是默认用户名 Dev Hub 用户名。然后，您可以在不使用该标志的情况下成功创建临时组织。但是，当您尝试创建一个临时组织时 再次使用相同的CLI命令时，您会收到以下错误：–set-default-dev-hub–target-dev-hub

Error (1): No default dev hub found. Use -v or --target-dev-hub to specify an environment.

发生了什么事？

答：您不再位于运行 authorization 命令的目录中。这 使用标志的目录很重要。–set-default-dev-hub

如果从项目目录的根目录运行 authorization 命令，则会在本地设置配置变量。价值 仅当从同一项目目录运行命令时才适用。如果更改为 不同的目录并运行，本地 默认 Dev Hub 组织的设置不再适用，并且出现错误。target-dev-huborg create scratch

通过执行下列操作之一来解决问题。

• 全局设置，以便可以从任何目录运行。target-dev-huborg create scratchsf config set target-dev-hub=<devhubusername> --global
• 从同一项目目录运行，其中 你已授权开发人员中心组织。org create scratch
• 使用 标志 with 从任何目录运行它。–target-dev-huborg create scratchsf target-dev-hub --definition-file <file> --target-dev-hub <devhubusername> --alias my-scratch-org
• 若要检查是否已全局或本地设置配置值，请使用此命令并检查 “位置”列。sf config list

组织授权失败后无法工作

有时，您尝试使用 Salesforce CLI 或 一个 IDE，但您没有成功登录到组织。港口仍然对流浪者开放 授权过程，并且您不能使用 CLI 或 IDE。若要继续，请结束该过程 手动地。

macOS 或 Linux

要从 macOS 或 Linux 上失败的组织授权中恢复，请使用终端终止 在端口 1717 上运行的进程。

1. 在终端中，运行：lsof -i tcp:1717
2. 在结果中，找到使用该端口的进程的 ID。
3. 跑：kill -9 <the process ID>

窗户

要从 Windows 上失败的组织授权中恢复，请使用任务管理器结束节点 过程。

1. 按 Ctrl+Alt+Delete，然后单击“任务管理器”。
2. 选择“进程”选项卡。
3. 找到名为 的进程。Node注意如果您是 Node.js 开发人员，则可以使用此进程运行多个进程 名字。
4. 选择要结束的进程，然后单击“结束” 过程。

错误：使用者密钥已被获取

假设您在一个组织上运行 你已在其中创建已连接的应用。当您尝试将检索到的源部署到 不同的组织，部署失败并显示错误。发生了什么事？

project retrieve startThe consumer key is already taken

连接的应用包括网站或应用用来标识自身的使用者密钥 Salesforce的。使用者密钥在整个 Salesforce 生态系统中必须是唯一的。什么时候 您尝试部署检索到的 （和未更改的） 源文件与 将应用连接到新组织时，由于使用者密钥重复，部署失败。

有几个选项可以解决此问题。

• 在部署源之前，从项目中删除连接的应用源文件 到新组织。因此，不会创建连接的应用。连接的应用程序 源文件的名称类似于 。force-app/main/default/connectedApps/MyConnApp.connectedApp-meta.xml
• 更新已连接应用的文件，并将元素的值更改为唯一值。这是 显示元素的示例连接应用文件的代码片段。<consumerKey><consumerKey><?xml version="1.0" encoding="UTF-8"?> <ConnectedApp xmlns="http://soap.sforce.com/2006/04/metadata"> <contactEmail>john@doecompany.com</contactEmail> <contactPhone>5556789</contactPhone> <label>MyConnApp</label> <oauthConfig> <callbackUrl>http://localhost:1717/OauthRedirect</callbackUrl> <consumerKey>3MVG9PG9sFc71i9n55UWbx2</consumerKey> <isAdminApproved>false</isAdminApproved> ...

Salesforce DX 的限制

以下是您在使用 Salesforce DX 时可能遇到的一些已知问题。

有关最新的已知问题，请访问 Trailblazer Community 的已知问题页面。

Salesforce 命令行界面

如果与客户端密码一起使用，则授权失败auth:web:login描述： 如果您使用客户端 ID 和客户端密码运行，则无法使用 Salesforce CLI 发出 命令发送到临时组织，因为授权文件不正确 创建。auth:web:login

解决方法： 在没有客户端的情况下使用基于 Web 的流程 ID 和客户端密钥，或使用基于 JWT 的流程向组织授权。 有关开发说明，请参阅《Salesforce DX 开发人员指南》中的授权 Hub 和 Scratch 组织授权方法。Windows Defender 暂停 CLI 安装描述：在 Windows 上安装 Salesforce CLI 时， 你会看到 Windows Defender 警告。此消息是预期的，因为我们 更新了安装程序的代码签名证书。

解决方法：若要忽略此消息，请单击“运行” 反正。无法使用 Salesforce CLI 导入记录类型描述：运行命令时，我们不支持 RecordType。data:tree:import

解决方法：没有。对 Windows 上 Shell 环境的有限支持描述： Salesforce CLI 在命令提示符 （） 和 Powershell 上进行了测试。有已知的 Cygwin 和 Min-GW 环境中的问题，以及 Windows 子系统的问题 Linux （WSL）。将来可能会测试和支持这些环境 释放。现在，请改用受支持的 shell。cmd.exe

解决方法： 没有。该命令不 完成执行force:apex:test:run描述： 在某些情况下，该命令不会完成执行。例子 这些情况包括 Apex 测试或 Apex 测试中的编译错误 当另一个预编译正在进行时触发另一个预编译。force:apex:test:run

解决方法： 通过键入 control-C 停止命令执行。如果命令是 作为持续集成 （CI） 作业的一部分，请尝试设置环境 变量。SFDX_PRECOMPILE_DISABLE=true

Dev Hub 和 Scratch 组织

Salesforce CLI 有时无法识别 Scratch 组织 社区描述：有时（但并非在所有情况下）Salesforce CLI 不承认与社区一起创建临时组织 特征。您无法使用 CLI 打开临时组织，即使 暂存组织在开发人员中心中列出。

解决方法：你可以试试这个 解决方法，尽管它并不能在所有情况下解决问题。删除 暂存组织，然后使用 CLI 创建新的暂存组织。 删除和重新创建临时组织将计入您的每日临时记录 组织限制。拉取社区并部署社区时出错描述：发生此错误是因为临时组织没有 所需的访客许可证。

解决方法：在您的临时组织中 定义文件，如果指定了 Communities 功能，则还要指定 站点功能。

源管理

错误：删除自定义标签后未找到任何结果force:source:status描述：在暂存中删除自定义标签后，该命令将返回错误 组织。force:source:statusNo Results Found

解决方法：选项#1：如果您只有一个或两个划痕 组织，您可以通过其 生成的用户名，请使用此解决方法。在 你的 DX project/.sfdx/org 目录，仅删除 受影响的临时组织所在的文件夹。

选项#2：如果你有 与您的 DX 项目相关的几个临时组织，而您不知道 要删除哪个临时组织的本地数据，请使用此解决方法。删除 Your DX project/.sfdx/org 目录。此目录包含所有 与项目相关的临时组织。当您运行下一个 source-tracking 命令，用于此组织或其他临时组织 （， ， 或 ），CLI 将重建 该组织的源跟踪信息。source:pushsource:pullsource:status

删除 目录（在选项 #1 或选项 #2 之后），再次运行。force:source:status错误：名为“Account.PersonAccount”的“RecordType”类型的实体不能是 发现描述： 尽管您可以在临时打开个人帐户 组织，将该功能添加到您的临时组织定义中，运行或导致错误，source:pushsource:pull

解决方法： 没有。force：source：convert 不会将安装后脚本添加到包 .xml描述：如果运行 ，package.xml 不包含帖子 安装脚本。force:source:convert解决方法：若要解决此问题，请选择以下选项之一 方法：

• 手动将元素添加到元数据目录中的 package.xml 中 产生<postInstallClass>force:source:convert
• 手动将元素添加到发布组织中的包中，或者 要将软件包部署到的组织。

必须在对象的元数据文件中手动启用源跟踪描述：如果您在标准或自定义设备上启用 Feed 跟踪 对象，然后运行 ， Feed 跟踪未启用。force:source:pull

解决方法：在您的 Salesforce 中 DX项目，手动启用标准或自定义的Feed跟踪 对象在其元数据文件 （-meta.xml） 中添加 .<enableFeeds>true</enableFeeds>无法将查找筛选器推送到临时组织描述： 执行命令推送关系源时 字段，有时会收到以下错误：force:source:push

duplicate value found: <unknown> duplicates value on record with id: <unknown> at line num, col num.

解决方法： 没有。

部署

部署时编译可能会增加临时组织中的部署时间描述： 如果您的 Apex 代码部署时间很慢，您的临时组织可能会 有设置 设置为 。enableCompileOnDeploytrue解决方法：要将其关闭，请将其设置为 （ default） 或从 Scratch 组织中删除该设置 定义。

false

{
  "orgName": "ekapner Company",
  "edition": "Developer",
  "features": [],
  "settings": {
    "lightningExperienceSettings": {
          "enableS1DesktopEnabled": true
      },
      "apexSettings": {
          "enableCompileOnDeploy": false
      }
  }
}

托管的第一代软件包

在临时组织中安装软件包时，不会执行任何测试描述： 如果将测试作为连续测试的一部分 集成过程中，当您在 Scratch 组织。

解决方法： 您可以在 软件包已安装。CLI 中用于托管包密码的新术语描述： 使用 CLI 将安装密钥添加到软件包版本或 要安装受密钥保护的软件包版本，密钥的参数名称为 。当您查看 Salesforce 用户界面中的托管包版本，相同的包 属性称为“密码”。在 API 中，对应的字段名称， “password”，保持不变。–installationkey

解决方法： 没有。

托管的第二代软件包

无法为托管软件包指定修补程序版本描述： 由四部分组成的软件包版本号包括一个补丁段，定义 作为 major.minor.patch.build。但是，您不能为 第二代托管包。如果设置了修补程序，则软件包创建将失败 包描述符中的数字。我们计划为 Winter ’20 版本中的托管包。

解决方法： 始终设置 版本号的补丁段，设置为 0。例如，1.2.0.1 是 有效，但 1.2.1.1 无效。受保护的自定义元数据和自定义设置对开发人员可见 临时组织（如果已安装的软件包共享命名空间）描述： 将机密存储在 使用受保护的自定义元数据或受保护的第二代包 自定义设置。您可以使用 相同的命名空间。但是，当您在临时组织中安装这些软件包时， 这些机密对于在 具有共享命名空间的 Scratch 组织。将来，我们可能会添加一个 “package-protected” 关键字来防止访问这些中的包机密 情况。

解决方法： 没有。

解锁套餐

受保护的自定义元数据和自定义设置对开发人员可见 临时组织（如果已安装的软件包共享命名空间）描述： 在解锁的密钥中存储密钥时要小心 使用受保护的自定义元数据或受保护的自定义设置的包。你 可以创建多个具有相同命名空间的解锁包。但是，当 您在临时组织中安装这些软件包，这些密钥对 在临时组织工作的任何开发人员，共享 命名空间。将来，我们可能会在 在这些情况下阻止访问包机密。

解决方法： 没有。

ref

包是一个顶级容器，用于保存有关应用或 package：包名称、描述和关联的命名空间。

您可以在 sfdx-project.json 项目配置文件的包描述符部分中提供包详细信息。

• 创建和更新已解锁的包 准备好测试或共享包时，请使用命令创建包
  。sf package create
• 创建已解锁包
  的新版本 包版本是包内容和相关元数据的固定快照。通过包版本，可以管理更改，并跟踪每次发布或部署一组特定更改时的不同之处。
• 未锁定包的代码覆盖率 在升级和发布已解锁的包
  之前，Apex 代码必须满足至少 75% 的代码覆盖率要求。您只能在临时组织和沙盒中安装不符合代码覆盖率要求的软件包版本。
• 释放解锁的软件包 每个新的软件包
  版本在创建时都标记为 beta。在开发软件包时，您可以先创建多个软件包版本，然后再创建准备在生产组织中发布和安装的版本。
• 更新已解锁的包版本 您可以从命令行更新包版本
  的大多数属性。例如，您可以更改包版本名称或说明。一个重要的例外是无法更改发布状态。
• 未锁定软件包中的硬删除组件 当这些组件从未锁定的软件包中删除时，它们将在软件包
  升级期间从目标安装组织中硬删除。
• 删除已解锁的包或包版本 使用 和 删除不再需要的包和包版本
  。sf package version deletesf package delete
• 查看软件包详细信息
  从命令行查看以前创建的软件包和软件包版本的详细信息。

创建和更新已解锁的软件包

准备好测试或共享包时，请使用命令创建包。

sf package create

如果您使用的是命名空间，请在 sfdx-project.json 文件中指定包命名空间。若要了解详细信息，请参阅了解命名空间。

若要创建包，请转到项目目录。名称成为包 alias，它会自动添加到项目文件中。您可以选择指定一个 活跃的 Dev Hub 组织用户接收 Apex gacks 的电子邮件通知，并安装， 升级或卸载与程序包关联的失败。

sf package create --name "Expenser App" --package-type Unlocked --path  \
"expenser-main" --target-dev-hub my-hub --error-notification-username me@devhub.org

输出与此示例类似。

sfdx-project.json has been updated.
Successfully created a package. 0HoB00000004CzHKAU
=== Ids
NAME        VALUE
──────────  ──────────────────
Package Id  0HoB00000004CzHKAU

更新程序包

要更新名称、描述或用户以接收 现有包，请使用此 命令。

sf package update --package "Expense App" --name "Expense Manager App" \
--description "New Description" --error-notification-username me2@devhub.org

注意

你 创建 包。

创建已解锁包的新版本

包版本是包内容和相关元数据的固定快照。 通过包版本，您可以管理更改并跟踪每次发布时的不同之处 或部署一组特定的更改。

在创建包版本之前，请先验证包详细信息，例如包 sfdx-project.json 文件中的名称、依赖项以及主要版本号、次要版本号和修补程序版本号。验证所需的元数据 更改或添加新的包版本位于包的主目录中。

我每天可以创建多少个包版本？

运行此命令以查看每天可以创建多少个包版本以及有多少个 你还剩下。

sf limits api display

查找 Package2VersionCreates 条目。

NAME                                   REMAINING  MAXIMUM
─────────────────────────────────────  ─────────  ─────────
Package2VersionCreates                  23         50

创建包版本

使用此命令创建包版本。指定软件包别名或 ID （0Ho）。 还可以包括一个临时定义文件，该文件包含特征列表和 设置包版本所依赖的元数据。

sf package version create --package "Expenser App" --installation-key “HIF83kS8kS7C” \
--definitionfile config/project-scratch-def.json --wait 10

注意

创建包版本时，请指定在非异步模式下运行命令的时间。如果 在该时间内创建包版本时，sfdx-project.json 文件会自动更新为 包版本信息。否则，必须手动编辑项目文件。–wait

创建包版本可能是一个长时间运行的过程，具体取决于 包大小和其他变量。您可以轻松查看状态和监控 进展。

sf package version create report --package-create-request-id 08cxx00000000YDAAY

输出显示有关请求的详细信息。

=== Package Version Create Request 
NAME                            VALUE
─────────────────────────────   ────────────────────
Version Create Request Id       08cB00000004CBxIAM 
Status                          InProgress 
Package Id                      0HoB00000004C9hKAE 
Package Version Id              05iB0000000CaaNIAS
Subscriber Package Version Id   04tB0000000NOimIAG
Tag                             git commit id 08dcfsdf
Branch 
CreatedDate                     2018-05-08 09:48
Installation URL
https://login.salesforce.com/packaging/installPackage.apexp?p0=04tB0000000NOimIAG

您可以在 的初始输出中找到请求 ID （08c）。sf package version create

根据包的大小和其他变量，创建请求可以采用 几分钟。当有多个待处理的创建包请求时 版本，您可以使用此命令查看所有请求的列表。

sf package version create list --created-last-days 0

显示每个请求的详细信息，如下所示（ID 和标签被截断）。

=== Package Version Create Requests [3] 
ID     STATUS  PACKAGE2 ID PKG2 VERSION ID SUB PKG2 VER ID TAG BRANCH CREATED DATE === 
08c... Error   0Ho...      
08c... Success 0Ho... 05i... 04t...                                   2017-06-22 12:07 
08c... Success 0Ho... 05i... 04t...                                   2017-06-23 14:55

使用关键字 NEXT 确保包版本号是唯一的

若要确保版本号是唯一的，请在 sfdx-project.json 文件中设置版本号时使用关键字 NEXT。

例如。“versionNumber”: “1.2.0.NEXT”

如果您不使用 NEXT，并且您也忘记更新版本 sfdx-project.json 文件中的数字，即新的包版本 使用与以前的包版本相同的编号。虽然我们不强制执行 包版本号的唯一性，每个包版本都分配了一个唯一的 订阅者包版本 ID（以 04t 开头）。

• 通过创建和指定组织配置
  来简化未锁定的包开发 如果包的元数据依赖于一组复杂的功能、设置或许可证，则很难在临时组织定义文件中以声明方式指定这些依赖项。相反，请创建生产组织或其他开发组织的组织形状，并在临时组织定义文件中指定该源组织的 ID。在包创建过程中，我们会在构建和验证包的元数据时模拟源组织的环境。
• 在未锁定的打包中使用分支 在源代码管理系统 （SCS）
  中使用分支的开发团队通常会根据特定代码分支中的元数据生成包版本。
• 跳过验证以快速迭代未锁定的包开发 通过在包版本创建期间跳过对依赖项、包祖先和元数据的验证，更高效地迭代包开发
  。跳过验证可减少创建新包版本所需的时间，但只能将已验证的包版本提升为已发布状态。
• 在 Salesforce 版本转换期间，为解锁的包定位特定版本
  在主要的 Salesforce 版本转换期间，您可以指定 或 在创建包版本时。通过指定软件包的发布版本，您可以测试即将推出的功能、运行回归测试并为客户提供支持，而不管他们的组织使用的是哪个 Salesforce 版本。以前，您只能创建与您的 Dev Hub 组织所在的 Salesforce 版本相匹配的软件包版本。previewprevious

通过创建和指定组织形状来简化解锁包开发

如果包的元数据依赖于一组复杂的功能， 设置或许可证，可能很难在 临时组织定义文件。相反，请创建生产组织的组织形状或其他组织形状 development org，并在临时组织定义文件中指定该源组织的 ID。在 包创建时，我们会在构建和验证 包的元数据。

在使用此功能之前，请熟悉 Org Shape for Scratch Orgs 的工作原理。

然后在源组织中启用临时组织设置，生成组织形状，然后 编辑临时组织定义文件以包含组织名称和 15 个字符的源组织 同上。

{
  "orgName": "Acme",
  "sourceOrg": "00DB1230400Ifx5"
}

在解锁的包装中使用分支

在源代码管理系统 （SCS） 中使用分支的开发团队，通常 基于特定代码分支中的元数据生成包版本。

若要确定包版本基于 SCS 中的哪个分支，请标记包版本 与分支名称一起使用属性 Salesforce CLI 命令。–branch

sf package version create –branch featureA

您可以指定任何字母数字值（最多 240 个字符）作为分支名称。

您还可以在 sfdx-project.json 文件的包目录部分中指定分支名称。

"packageDirectories": [
     {
        "path": "util",
        "default": true,
        "package": "pkgA",
        "versionName": "Spring ‘21",
        "versionNumber": "4.7.0.NEXT",
        "branch": "featureA"
     }]

指定分支时，该包版本的包别名会自动 附加分支名称。您可以在 sfdx.project.json 文件中查看包别名。

"packageAliases": {
    "pkgA@1.0.0.4-featureA":"04tB0000000IB1EIAW"}

请记住，版本号在每个分支内递增，而不是在分支之间递增。为 例如，可以有两个或多个版本号为 1.3.0.1 的 beta 包版本。

尽管多个 beta 包版本可以具有相同的版本号，但可以有 对于给定的 major.minor.patch 软件包版本，只有一个已提升和发布的软件包版本。

包依赖项和分支

默认情况下，您的包可以依赖于同一分支中的其他包。为 基于其他分支中的包依赖，在 sfdx.project.json 文件。

跳过验证，快速迭代解锁包开发

通过跳过依赖项的验证，更高效地迭代包开发， 包上级，以及包版本创建期间的元数据。跳过验证会减少 创建新的包版本所需的时间，但只能升级已验证的包版本 设置为释放状态。

sf package version create --skip-validation

在工具 API 中，使用 Package2VersionCreateRequest 对象上的 SkipValidation 字段。

注意

不能同时指定跳过验证和代码覆盖率，因为代码覆盖率是 在验证期间计算。

在 Salesforce 版本转换期间，为已解锁的软件包定位特定版本

在主要的 Salesforce 版本转换期间，您可以指定或何时 创建包版本。通过指定包的发布版本，可以进行测试 即将推出的功能，运行回归测试，并为客户提供支持，无论使用哪种 Salesforce 释放他们的组织已开启。以前，您只能创建与 Salesforce 发布您的开发人员中心组织。

previewprevious要基于预览版或以前的 Salesforce 发行版创建包版本，请创建 一个临时组织定义文件，其中包括：

{
    "release": "previous"
}

或

{
    "release": "preview"
}

在 sfdx-project.json 文件中，将 设置为与包版本的发布版本相对应 创建。如果以以前的版本为目标，则接受低于当前版本的任何值。sourceApiVersionsourceApiVersion然后，在创建软件包版本时，指定临时组织定义 文件。

sf package version create --package pkgA --definition-file config/project-scratch-def.json

预览开始日期是升级沙盒实例的时间。预览结束日期是所有 实例位于 GA 版本上。

解锁包的代码覆盖率

在升级和发布未锁定的软件包之前，Apex 代码必须满足 最低 75% 的代码覆盖率要求。可以安装不符合代码的包版本 仅在临时组织和沙盒中的覆盖率要求。

重要

之前已提升为已发布状态的已解锁包版本 Winter ’21 不受代码覆盖率要求的约束。

要使用 Salesforce CLI 计算代码覆盖率，请在运行命令时使用该参数。–code-coveragesf package version create

在计算代码覆盖率时，包版本创建可能需要更长的时间才能完成，因此 考虑在开发周期中何时包含代码覆盖率参数。您可以选择 跳过代码覆盖率，并且可以通过指定参数来跳过所有验证。您可以升级包版本 仅当它们经过验证并满足代码覆盖率要求时。–skip-validation

查看包版本的代码覆盖率信息，使用参数或 Salesforce 命令行界面。sf package version list –verbosesf package version report

我们不会计算依赖于组织的解锁包的代码覆盖率。

释放解锁的软件包

每个新的软件包版本在创建时都标记为 beta。当您开发您的 package，在创建准备好的版本之前，可以创建多个包版本 在生产组织中发布和安装。

在升级包版本之前，请确保在 Dev 中启用了用户权限“将包版本提升为已发布” 与包关联的中心组织。请考虑使用此用户创建权限集 权限，然后将权限集分配给相应的用户配置文件。

当您准备好发布时，请使用 .sf package version promote

sf package version promote --package "Expense Manager@1.3.0-7"

如果命令成功，则会显示一条确认消息。

Successfully promoted the package version, ID: 04tB0000000719qIAA to released.

更新成功后，查看包详细信息。

sf package version report --package "Expense Manager@1.3.0.7"

确认 Released 属性的值为 。true

=== Package Version
NAME                            VALUE
──────────────────────────────  ───────────────────
Name                            ver 1.0
Alias                           Expense Manager-1.0.0.5
Package Version Id              05iB0000000CaahIAC
Package Id                      0HoB0000000CabmKAC
Subscriber Package Version Id   04tB0000000NPbBIAW
Version                         1.0.0.5
Description                     update version
Branch
Tag                             git commit id 08dcfsdf
Released                        true
Created Date                    2018-05-08 09:48
Installation URL
https://login.salesforce.com/packaging/installPackage.apexp?p0=04tB0000000NPbBIAW

你 对于每个包版本号，只能升级和发布一次，并且无法撤消 此更改。

更新已解锁的软件包版本

您可以从命令行更新包版本的大多数属性。例如 您可以更改包版本名称或说明。一个重要的例外是你不能 更改发布状态。

如果已发布最新的软件包版本，请递增主要版本、次要版本或 您创建的下一个软件包版本的修补程序版本号。

软件包版本号使用格式 major.minor.patch.build。例如，如果您发布了 软件包 1.0.0.2，您可以使用 1.1.0.0、2.0.0.0 或 1.0.1.0 作为下一个软件包版本。

未锁定软件包中硬删除的组件

当这些组件从未锁定的包中删除时，它们将从 软件包升级期间的目标安装组织。

• AccountForecastSettings
• AcctMgrTargetSettings
• ActionableListDefinition
• ActionPlanTemplate
• AccountingFieldMapping
• AccountingModelConfig
• AdvAccountForecastSet
• AdvAcctForecastDimSource
• AdvAcctForecastPeriodGroup
• AIApplicationConfig
• AIUsecaseDefinition
• AnalyticSnapshot
• ApexClass
• ApexComponent
• ApexPage
• ApexTrigger
• ApplicationRecordTypeConfig
• ApplicationSubtypeDefinition
• AppointmentAssignmentPolicy
• AssessmentQuestion
• AssessmentQuestionSet
• AssistantContextItem
• AssistantSkillQuickAction
• AssistantSkillSobjectAction
• AssistantVersion
• AuraDefinitionBundle
• BatchCalcJobDefinition
• BatchProcessJobDefinition
• BenefitAction
• BldgEnrgyIntensityCnfg
• BrandingSet
• BriefcaseDefinition
• BusinessProcessGroup
• BusinessProcessTypeDefinition
• CareBenefitVerifySettings
• CareLimitType
• CareProviderSearchConfig
• CareRequestConfiguration
• ChannelObjectLinkingRule
• ClaimFinancialSettings
• ClauseCatgConfiguration
• CompactLayout
• ContractType
• ConversationVendorInfo
• CustomApplication
• CustomPageWebLink
• CustomPermission
• CustomTab
• Dashboard
• DecisionMatrixDefinition
• DecisionMatrixDefinitionVersion
• DecisionTable
• DecisionTableDatasetLink
• DisclosureDefinition
• DisclosureDefinitionVersion
• DisclosureType
• DiscoveryAIModel
• DiscoveryGoal
• Document
• DocumentGenerationSetting
• DocumentType
• EmailServicesFunction
• EmailTemplate
• EmbeddedServiceBranding
• EmbeddedServiceConfig
• EmbeddedServiceLiveAgent
• EmbeddedServiceMenuSettings
• ESignatureConfig
• ESignatureEnvelopeConfig
• ExplainabilityActionDefinition
• ExplainabilityActionVersion
• ExplainabilityMsgTemplate
• ExpressionSetDefinition
• ExpressionSetDefinitionVersion
• ExpressionSetObjectAlias
• ExternalAIModel
• ExternalClientApplication
• ExtlClntAppMobileSettings
• ExtlClntAppOauthSettings
• ExternalDataSrcDescriptor
• ExternalServiceRegistration
• FeatureParameterBoolean
• FeatureParameterDate
• FeatureParameterInteger
• FieldRestrictionRule
• FieldServiceMobileExtension
• FlexiPage
• FuelType
• FuelTypeSustnUom
• GatewayProviderPaymentMethodType
• HomePageComponent
• HomePageLayout
• IdentityVerificationProcDef
• InstalledPackage
• IntegrationHubSettings
• IntegrationHubSettingsType
• IntegrationProviderDef
• Layout
• Letterhead
• LicenseDefinition
• LightningComponentBundle
• LightningExperienceTheme
• LightningMessageChannel
• LightningOnboardingConfig
• ListView
• LiveChatAgentConfig
• LiveChatButton
• LiveChatSensitiveDataRule
• LocationUse
• LoyaltyProgramSetup
• MarketingAppExtActivity
• MarketingAppExtension
• MatchingRule
• MfgProgramTemplate
• MLDataDefinition
• MLPredictionDefinition
• NamedCredential
• NetworkBranding
• ObjectHierarchyRelationship
• OcrSampleDocument
• OcrTemplate
• OmniDataTransform
• OmniIntegrationProcedure
• OmniScript
• OmniUiCard
• PaymentGatewayProvider
• PermissionSet
• PermissionSetGroup
• PermissionSetLicense
• PipelineInspMetricConfig
• PlatformEventSubscriberConfig
• ProductAttributeSet
• ProductSpecificationTypeDefinition
• Profile
• QuickAction
• RecordAlertCategory
• RecordAlertDataSource
• RegisteredExternalService
• RelatedRecordAssocCriteria
• RelationshipGraphDefinition
• RemoteSiteSetting
• Report
• ReportType
• RestrictionRule
• SalesAgreementSettings
• SchedulingRule
• SchedulingObjective
• ScoreCategory
• ServiceAISetupDefinition
• ServiceAISetupField
• ServiceProcess
• SharingReason
• SharingRecalculation
• SlackApp
• StaticResource
• StnryAssetEnvSrcCnfg
• SustainabilityUom
• SustnUomConversion
• SvcCatalogCategory
• SvcCatalogFulfillmentFlow
• SvcCatalogItemDef
• TimelineObjectDefinition
• UIObjectRelationConfig
• UserAccessPolicy
• UserLicense
• UserProfileSearchScope
• ValidationRule
• VehicleAssetEmssnSrcCnfg
• ViewDefinition
• VirtualVisitConfig
• WaveApplication
• WaveComponent
• WaveDashboard
• WaveDataflow
• WaveDataset
• WaveLens
• WaveRecipe
• WaveTemplateBundle
• WaveXmd
• WebLink
• WebStoreTemplate
• WorkflowAlert
• WorkflowFieldUpdate
• WorkflowFlowAction
• WorkflowOutboundMessage
• WorkflowRule
• WorkflowTask

删除未锁定的软件包或软件包版本

使用 和 删除包和包版本 你不再需要了。

sf package version deletesf package delete

若要删除包或包版本，用户需要“删除第二代包”用户 许可。在删除包之前，请先删除所有关联的包版本。

删除包或包版本的注意事项

• 删除是永久性的。
• 尝试安装已删除的软件包版本将失败。
• 在删除之前，请确保包或包版本未被引用为 屬地。

例子：

$ sf package delete -p "Your Package Alias"

$ sf package delete -p 0Ho...

$ sf package version delete -p "Your Package Version Alias"

$ sf package version delete -p 04t...

这些 CLI 命令不能用于第一代托管包或包版本。 若要删除第一代托管包，请参阅第一代托管打包开发人员中的查看包详细信息 指南。

查看软件包详细信息

从命令查看以前创建的包和包版本的详细信息 线。若要显示开发人员中心组织中所有包的列表，请使用此命令。

sf package list --target-dev-hub my-hub

可以在输出中查看命名空间、包名称、ID 和其他详细信息。

Name              Id                  Alias           Description  Type
───────────────   ──────────────────  ──────────────  ───────────  ───────────  ───────
Expenser App      0HoB00000004CzRKAU  Expenser App                 Unlocked
Expenser Logic    0HoB00000004CzMKAU  Expenser Logic               Unlocked
Expenser Schema   0HoB00000004CzHKAU  Expenser Schema              Unlocked

包括可选参数以根据修改日期筛选列表结果， 创建日期，并按特定字段或包 ID 排序。要限制详细信息，请使用 .要显示展开的详细信息，请使用 。–concise–verbose

若要显示开发人员中心组织中所有包版本的列表，请使用此命令。

sf package version list --target-dev-hub my-hub

您可以在输出中查看命名空间、版本名称和其他详细信息。

Package Name      Namespace  Version  Sub Pkg Ver Id       Alias                    Installation Key  Released  
───────────────  ──────────  ───────  ───────────────────  ───────────────────────  ─────────────────  ───────
Expenser Schema              0.1.0.1  04tB0000000719qIAA   Expenser Schema@0.1.0-1   false             true
Expenser Schema              0.2.0.1  04tB000000071AjIAI   Expenser Schema@0.2.0-1   false             true
Expenser Schema              0.3.0.1  04tB000000071AtIAI   Expenser Schema@0.3.0-1   false             false
Expenser Schema              0.3.0.2  04tB000000071AyIAI   Expenser Schema@0.3.0-2   false             true
Expenser Schema              0.3.1.1  04tB0000000KGU6IAO   Expenser Schema@0.3.1-1   false             false
Expenser Schema              0.3.1.2  04tB0000000KGUBIA4   Expenser Schema@0.3.1-2   false             true
Expenser Schema              0.3.2.1  04tB0000000KGUQIA4   Expenser Schema@0.3.2-1   false             true
Expenser Logic               0.1.0.1  04tB0000000719vIAA   Expenser Logic@0.1.0-1    false             true
Expenser App                 0.1.0.1  04tB000000071A0IAI   Expenser App@0.1.0-1      false             true

为未锁定的软件包推送软件包升级

通过推送升级，您可以升级订阅者组织中安装的软件包，而无需 要求客户自行安装升级。您可以选择接收推送的组织 upgrade、包升级到的版本以及您希望何时进行升级。推 升级特别有用：如果您需要推送更改以修复热错误。

使用 SOAP API 启动推送升级、跟踪每个作业的状态并查看错误 消息，如果任何推送升级失败。以下是有助于推送升级的对象。

已解锁软件包的推送升级注意事项

• 您可以包含新功能和更改的功能，也可以在推送升级期间删除功能。
• 安装推送升级时，将遵守软件包中的 Apex。
• 即使包版本需要密码，也可以使用推送升级。

安装解锁的软件包

使用 CLI 或浏览器安装未锁定的软件包。您可以安装软件包版本 在临时组织、沙盒组织、DE 组织或生产组织中。

• 使用 CLI
  安装软件包 如果您使用的是 Salesforce CLI，则可以使用该命令在临时组织或目标订阅者组织中安装软件包。sf package install
• 从 URL
  安装未锁定的软件包 从 CLI 或浏览器安装未锁定的软件包，类似于安装托管软件包的方式。
• 升级已解锁包
  的版本 是否要对现有包进行元数据更改？您可以使用 CLI 将一个软件包版本升级到另一个软件包版本。
• 用于安装具有依赖项的未锁定包的示例脚本
  使用此示例脚本作为创建自己的脚本的基础，以安装具有依赖项的包。此脚本包含一个查询，用于查找依赖包并按正确的依赖顺序安装它们。

使用 CLI 安装软件包

如果您使用的是 Salesforce CLI，则可以使用该命令在临时组织或目标订阅者中安装软件包 组织。

sf package install

在将软件包安装到临时组织之前，请运行此命令以列出所有软件包和 找到 ID 或包别名。

sf package version list

确定要安装的版本。输入此命令，提供软件包别名或 程序包 ID（以 04t 开头）。

sf package install --package "Expense Manager@1.2.0-12" --target-org jdoe@example.com

如果您已使用默认用户名设置了临时组织，请仅输入软件包版本 同上。

sf package install --package "Expense Manager@1.2.0-12"

注意

如果您定义了别名（使用参数），则 可以指定 的别名而不是用户名。-a–target-org

CLI 显示有关安装的状态消息。

Waiting for the subscriber package version install request to get processed. Status = InProgress Successfully installed the subscriber package version: 04txx0000000FIuAAM.

控制包安装超时

当您发出命令时，它需要 几分钟后，软件包版本将在目标组织中可用，并安装到 完成。要留出足够的时间成功安装，请使用以下参数表示 互斥计时器。sf package install

• –publish-wait定义 该命令等待软件包版本在目标组织中可用。默认值为 0。 如果在此时间范围内该软件包在目标组织中不可用，则安装是 终止。当您 创建新的包版本，然后立即尝试将其安装到目标 组织。–publish-wait注意如果设置为 0，则包 安装会立即失败，除非软件包版本在目标中已可用 组织。–publish-wait
• –wait定义 命令在软件包可用后等待安装完成。默认值为 0. 间隔结束时，install 命令 完成，但安装将继续，直到失败或成功。您可以轮询 使用 的安装状态。–waitsf package install report注意计时器在以下时间后生效 指定的时间已过。如果时间间隔在包 在目标组织中可用，间隔从不 开始。–wait–publish-wait–publish-wait–wait

例如，考虑一个名为 Expense Manager 的包，它需要 5 分钟才能变成 在目标组织上可用，安装时间为 11 分钟。以下命令已设置为 3 分钟和 10 分钟。由于 Expense Manager 需要的时间超过设置的时间间隔，因此安装将在 三分钟间隔结束。

publish-waitwaitpublish-waitpublish-wait

sf package install --package "Expense Manager@1.2.0-12" --publish-wait 3 --wait 10

这 以下命令已设置为 6 分钟，并设置为 10 分钟。如果尚不可用，则费用 Manager 需要 5 分钟才能在目标组织上可用。然后时钟开始滴答作响 10分钟的时间。在 10 分钟结束时， 命令完成，因为时间间隔具有 已过，但安装尚未完成。此时，表示安装已在 进展。再过一分钟，安装完成并指示成功 安装。

publish-waitwaitwaitwaitsf package install reportsf package install report

sf package install --package "Expense Manager@1.2.0-12" --publish-wait 6 --wait 10

从 URL 安装未锁定的软件包

从 CLI 或浏览器安装未锁定的软件包，类似于安装方式 托管包。

如果从 CLI 创建软件包，则可以派生 通过将订阅者包 ID 添加到开发人员中心 URL 来包。您可以使用此 URL 进行测试 不同的部署或安装方案。

例如，如果包版本具有 订阅者包 ID 04tB00000009oZ3JBI，将 ID 添加为 apvId。https:// 我的域名.lightning.force.com/packagingSetupUI/ipLanding.app?apvId=04tB00000009oZ3JBI

任何人 使用 URL 和 Salesforce 组织的有效登录名可以安装软件包。要安装软件包，请执行以下操作：

1. 在浏览器中，输入安装 URL。
2. 输入要在其中安装 包，然后单击“登录”。
3. 如果软件包受安装密钥保护，请输入安装密钥。
4. 对于默认安装，请单击“安装”。一条消息描述了 进展。安装完成后，您会收到一条确认消息。

升级已解锁软件包的版本

是否要对现有包进行元数据更改？您可以使用 CLI 执行以下操作 将一个软件包版本升级到另一个软件包版本。

执行包升级时，以下是元数据更改的预期内容。

升级到新的包版本时，可以选择是否要求成功 编译组织和包中的所有 Apex （），或仅编译包中的 Apex （）。–apex-compile all–apex-compile package

• 新版本中引入的元数据将作为升级的一部分进行安装。
• 如果升级后的组件与目标组织中已有的组件具有相同的 API 名称， 组件将被更改覆盖。
• 如果升级中的组件已从目标组织中删除，则会重新创建该组件 在升级期间。
• 在新软件包版本中删除的元数据也会从目标组织中删除 作为升级的一部分。已删除的元数据是当前包中未包含的元数据 版本安装，但存在于目标组织中安装的先前软件包版本中。如果 在升级发生之前删除元数据，升级将正常进行。一些例子 其中元数据已弃用且未删除：
  • 用户在自定义对象和字段中输入的数据将被弃用，并且不会被删除。管理员 如有必要，可以导出此类数据。
  • 不推荐使用 Apex 类之类的对象，如果在 作为软件包一部分的 Lightning 组件。
• 在 API 版本 45.0 及更高版本（Salesforce CLI 版本 45.0.9 或更高版本）中，您可以指定 在软件包升级期间删除的元数据会发生什么情况。使用命令的 | 参数，指定以下值之一：sf package install-t–upgrade-type
  • Delete指定删除所有已删除的内容 组件，但自定义对象和自定义字段除外，没有 依赖。
  • DeprecateOnly指定所有删除 组件必须标记为已弃用。已删除的元数据存在于目标组织中 包升级后，但在 UI 中显示为包中已弃用。这 选项在将元数据从一个包迁移到另一个包时很有用。
  • Mixed（默认值）指定某些已删除 组件将被删除，其他组件将被标记为已弃用。更多信息 在硬删除的组件上，请参阅未锁定包中的硬删除组件。

注意

对于软件包安装到生产组织或任何启用了 Apex Compile on Deploy 的组织， 平台在软件包安装或升级操作后编译组织中的所有 Apex 完成。此方法可确保软件包安装和升级不会影响 组织的性能，即使指定了，也会完成。–apex-compile package

用于安装具有依赖项的未锁定包的示例脚本

使用此示例脚本作为创建自己的脚本的基础，以使用 依赖。此脚本包含一个查询，用于查找依赖包并安装它们 以正确的依赖顺序。

示例脚本

注意

请务必将软件包版本 ID 和临时组织用户名替换为您自己的用户名 具体细节。

#!/bin/bash


# The execution of this script stops if a command or pipeline has an error.

# For example, failure to install a dependent package will cause the script

# to stop execution.

set -e


# Specify a package version id (starts with 04t)

# If you know the package alias but not the id, use sf package version list to find it.

PACKAGE=04tB0000000NmnHIAS


# Specify the user name of the subscriber org.

USER_NAME=test-bvdfz3m9tqdf@example.com


# Specify the timeout in minutes for package installation.

WAIT_TIME=15


echo "Retrieving dependencies for package Id: "$PACKAGE


# Execute soql query to retrieve package dependencies in json format.

RESULT_JSON=`sf data query -u $USER_NAME -t -q "SELECT Dependencies FROM SubscriberPackageVersion WHERE Id='$PACKAGE'" --json`


# Parse the json string using python to test whether the result json contains a list of ids or not.

DEPENDENCIES=`echo $RESULT_JSON | python -c 'import sys, json; print json.load(sys.stdin)["result"]["records"][0]["Dependencies"]'`


# If the parsed dependencies is None, the package has no dependencies. Otherwise, parse the result into a list of ids.

# Then loop through the ids to install each of the dependent packages.

if [[ "$DEPENDENCIES" != 'None' ]]; then


    DEPENDENCIES=`echo $RESULT_JSON | python -c '

import sys, json

ids = json.load(sys.stdin)["result"]["records"][0]["Dependencies"]["ids"]

dependencies = []

for id in ids:

    dependencies.append(id["subscriberPackageVersionId"])

print " ".join(dependencies)

'` 


    echo "The package you are installing depends on these packages (in correct dependency order): "$DEPENDENCIES

    for id in $DEPENDENCIES

    do

        echo "Installing dependent package: "$id

        sf package install --package $id -u $USER_NAME -w $WAIT_TIME --publish-wait 10

    done


else

    echo "The package has no dependencies"


fi


# After processing the dependencies, proceed to install the specified package.

echo "Installing package: "$PACKAGE

sf package install --package $PACKAGE -u $USER_NAME -w $WAIT_TIME --publish-wait 10


exit 0;

从未锁定的包中迁移已弃用的元数据

您可以弃用未锁定包中的元数据，将该元数据移动到新包中， ，然后在生产组织中安装新软件包。

创建更多解锁包时，可以重构包并将元数据从 如有必要，一个已解锁的包到另一个已解锁的包。

若要将生产元数据从包 A 移动到包 B，请按照下列步骤操作。

1. 确定要从包 A 移动到包 B 的元数据。
2. 从包 A 中删除元数据，创建版本，然后发布包。
3. 将元数据添加到包 B，创建版本，然后发布包。
4. 在生产组织中，升级软件包 A。
5. 在生产组织中，安装软件包 B。

元数据现在是生产组织中包 B 的一部分。

卸载已解锁的软件包

您可以使用 Salesforce CLI 或从设置 UI 从组织中卸载软件包。什么时候 卸载未锁定的软件包，软件包中的所有组件都将从 组织。要使用 CLI 从目标组织卸载包，请授权 Dev Hub 组织并运行 这 命令。

sf package uninstall --package "Expense Manager@2.3.0-5"

您还可以从 Web 浏览器卸载软件包。打开您 已安装软件包。

sf org open -u me@my.org

然后 卸载软件包。

1. 在“设置”中，输入“快速查找”框，然后 选择已安装的软件包。Installed Packages
2. 单击要删除的软件包旁边的“卸载”。
3. 确定是否保存和导出包数据的副本，然后选择 相应的单选按钮。
4. 选择“是，我想卸载”，然后单击“卸载”。

卸载软件包的注意事项

• 如果要卸载包含自定义对象的包，则该包上的所有组件 自定义对象也会被删除。已删除的项目包括自定义字段、验证规则、 自定义按钮和链接、工作流规则和审批流程。
• 每当卸载中未包含的组件时，都无法卸载软件包 引用包中的任何组件。例如：
  • 当已安装的软件包包含标准对象上的任何组件时，另一个 组件引用时，Salesforce 会阻止您卸载软件包。一 示例是一个包，其中包含一个自定义用户字段，该字段具有获取 当该字段的值为特定值时触发。卸载软件包 会阻止您的工作流程工作。
  • 安装两个不相关的包后，每个包都包含一个自定义对象和 一个自定义对象组件引用另一个组件中的组件，则无法卸载 包。例如，如果安装包含自定义的支出报表应用 user 字段，并在另一个已安装的自定义对象上创建验证规则，该对象 引用该自定义用户字段。但是，卸载支出报表应用 阻止验证规则起作用。
  • 当已安装的文件夹包含安装后添加的组件时， Salesforce 会阻止您卸载软件包。
  • 当您在以下时间添加的电子邮件模板中使用已安装的信笺抬头时 安装时，Salesforce 会阻止您卸载软件包。
  • 当已安装的软件包包含 Einstein 引用的自定义字段时 Prediction Builder 或 Case Classification，Salesforce 会阻止您卸载 包。在卸载包之前，请在“预测”中编辑预测 生成器或案例分类，使其不再引用自定义字段。
• 无法卸载删除所有活动企业和个人帐户记录的软件包 类型。激活至少一种其他企业或个人帐户记录类型，然后尝试 再。
• 如果后台作业正在更新由 包，例如对汇总摘要字段的更新。等到后台作业 完成，然后重试。

将解锁的包转移到其他开发人员中心

可以将已解锁包的所有权从一个开发人员中心组织转移到 另一个。

注意

此包转移功能仅适用于已解锁的包和第二代包 托管包。开发人员中心组织不与第一代托管包或非托管包一起使用 包，因此此功能不适用于这些包类型。

请求将包转移到其他开发人员中心

首先向 Salesforce 客户支持记录案例，并提供以下内容 详：

主题： 解锁的包传输到其他开发人员中心

描述：

在说明中，列出：

• 要传输的包的订阅者包 ID。此 ID 以 033 开头。自 验证包的 033 ID，在源上运行带有标志的命令 Dev Hub 组织。sf package list -–verbose
• 源组织的 Dev Hub 组织 ID。
• 目标组织的 Dev Hub 组织 ID。目标开发人员中心组织不能是开发人员 版本组织或试用组织。
• （可选）要传输的包的命名空间。如果包是无命名空间 解锁包，请跳过此步骤。
• 确认你已查看并完成了准备 Transfer Your Package 部分，包括将命名空间链接到目标 Dev Hub，并清除 Apex 错误通知用户。

如果您要转移多个包裹，请为每个包裹单独提交案例。

在您的案例通过审核和批准后，Salesforce 客户支持人员将 与您联系以安排启动包裹转移的时间。

注意

出于安全原因，包在位于政府云中的开发人员中心和 不允许使用位于政府云外部的 Dev Hub。

准备转移您的包裹

以下是您如何帮助确保包裹顺利转移的方法。

• 如果要传输的包具有命名空间，请将命名空间链接到源 开发人员中心。在包传输之前，命名空间必须链接到 源和目标开发人员中心组织。
• 在启动包传输过程之前，请确保所有推送升级或包 版本创建过程已完成。
• 删除不再需要的包版本。
• 如果指定，请使用命令清除包的错误通知用户。如果 你要将包转移到你拥有的开发人员中心组织，可以设置错误通知 包传输完成后，用户到目标开发人员中心中的用户。注意： 指定无值 在等号清除任何以前设置的用户名后。sf package update –error-notification-username=–error-notification-username=

在包裹转移过程中

在包之前，必须完成所有推送升级或包版本创建过程 传输过程已启动。Salesforce 客户支持将提醒您 将进行包裹转移。

包裹转移完成后

运行并验证包是否为否 与开发人员中心关联的时间更长。sf package list

包传输对包 ID 的影响

更新包项目文件

在开发人员中心创建新包或包版本之前，请更新 sfdx-project.json 文件并删除对传输的所有引用 package 从“package 目录”和“package alias”部分。

如果开发人员中心中有依赖于要传输的包的包，If you have packages in your Dev Hub which depends on the package that you-inter-transfer， 将 sfdx-project.json 文件中的 Package Dependency 部分更新为 显式指定您所依赖的传输包的 04t ID。

例如，如果将 pkgA 传输到其他开发人员中心，并且 sfdx-project.json 文件列出了如下所示的包依赖项。

"dependencies": [ 
   {
      "package": "pkgA"
      "versionNumber": "2.0.0.LATEST"
   }
]

更新依赖项以指定 pkgA 的 04t ID。

"dependencies": [ 
   {
      "package": "04tB0000000UzH5IAK"
   }
]

或者使用包别名指定依赖项。

"dependencies": [ 
   {
      "package": "pkgA2.0.0-1"
   }
"packageAliases": {
     "pkgA2.0.0-1": "04tB0000000UzH5IAK"
}
]

传输的包裹历史记录是什么？

当一个包被转移时，所有包版本和所有血统都是 转移。升级路径不受影响。

无论包传输是在你拥有的两个 Dev Hub 组织之间进行的，还是 包已从外部传输到你不拥有的开发人员中心，我们将传输包版本 历史。

我们转让：

• 包名称、命名空间、类型和 ID。一个例外是传输的包会得到一个 新的 0Ho ID。
• 包版本信息。这包括运行时通常显示的所有信息 或命令。sf package version listsf package version report

我们不转让：

• 推送升级历史记录。
• 包版本创建请求。
• 收到 Apex 和其他类型的错误通知的 Dev Hub 用户的用户名。 此可选用户是使用 设置的。–error-notification-username

• 获取从其他开发人员中心
  转移的已解锁包的所有权 可以获取从其他 Dev Hug 组织转移的已解锁包的所有权。

获取从其他开发人员中心转移的已解锁包的所有权

您可以获得从另一个 Dev Hug 转移的解锁包的所有权 组织。

若要从开发人员中心组织启动包传输，请参阅将解锁的包传输到其他开发人员中心。

注意

出于安全原因，包在位于政府云中的开发人员中心和 不允许使用位于政府云外部的 Dev Hub。

接收包裹转移

将收到的包的命名空间链接到开发人员中心组织。请参阅将命名空间链接到 Dev Hub 组织 Salesforce DX 开发人员指南。如果包未与 命名空间，请跳过此步骤。

包裹转移完成后

包裹转移完成后，Salesforce 客户支持将通知您。

若要验证传输的包是否与开发人员中心关联，请运行 。sf package list

包传输对包 ID 的影响

更新包项目文件

打开并查看关联的 sfdx-project.json 文件的内容 与转移的包。

打开并查看与 转移的包裹。定义文件有助于在开发过程中设置临时组织。 使用参数指定定义 文件。–definition-file

如果包目录部分列出了未传输给您的其他包， 从 sfdx-project.json 文件中删除这些引用。

接下来，查看 sfdx-project.json 文件的包别名部分，然后 删除对与包无关的包别名的任何引用 转移。

更新传输的包的包别名，以指定其 0Ho 包 ID。

创建新的包版本之前

与创建新包版本的方式类似，必须更新 sfdx-project.json 文件并更新版本号。

指定 Dev Hub 用户接收有关未处理的 Apex 异常的电子邮件通知，以及 安装、升级或卸载与包关联的失败时，请运行该命令，然后使用该参数。sf package update–error-notification-username

传输的包裹历史记录是什么？

我们转让：

• 包名称、命名空间、类型和 ID。一个例外是传输的包会得到一个 新的 0Ho ID。
• 包版本信息。这包括运行时通常显示的所有信息 或命令。sf package version listsf package version report

我们不转让：

• 推送升级历史记录。
• 包版本创建请求。
• 收到 Apex 和其他类型的错误的 Dev Hub 用户的用户名 通知。

Salesforce提供不同类型的软件包，解锁的软件包尤其如此 适用于内部业务应用程序。除非您计划在 AppExchange 上分发应用程序，否则 解锁包是大多数用例的正确包类型。您可以使用解锁的软件包来 整理现有元数据、打包应用、扩展已购买的应用 AppExchange 或打包新元数据。

解锁的包遵循源代码驱动的开发模型。元数据的真实来源 包中包含的是您的版本控制系统，而不是组织中的内容。该模型带来 有了它，现代源代码驱动开发模式的所有好处。

注意

如果您是 AppExchange 合作伙伴，并计划通过以下方式将您的应用程序分发给客户 AppExchange，使用第二代托管打包。有关详细信息，请参阅第二代托管软件包 信息。

• 什么是解锁套餐？
  如果你不熟悉打包，则可以将包视为填充元数据的容器。它包含一组相关功能、自定义项和架构。您可以使用包将元数据从一个 Salesforce 组织移动到另一个组织。
• 基于包的开发模型 为了演示解锁包的强大功能，以下是打包在传统开发模型
  中的工作方式。对于大多数生产组织，元数据传统上包含在两个存储桶中：一组从 AppExchange 安装的托管软件包和未打包的元数据。
• 在创建未锁定的包之前 使用未锁定的
  打包时，为确保正确设置它，请验证以下内容。
• 了解您的组织 您使用
  解锁包装的一些组织具有独特的用途。
• 创建与组织相关的未锁定包 与组织相关的未锁定包是未锁定包的变体，允许您在计划安装包的组织（安装组织）中创建依赖于未打包元数据的包
  。
• 解锁包
  的工作流 您可以直接从 Salesforce 命令行创建和安装解锁包。
• 配置解锁的软件包 您可以在每个软件包的
  sfdx-project.json 文件中包含一个条目，以指定其别名、版本详细信息、依赖项、功能和组织设置。在命令行中，还可以设置或更改选项，例如指定安装密钥、更新软件包名称或添加说明。
• 我们如何处理未锁定包
  中的配置文件设置 将配置文件打包到未锁定的或第二代托管包中时，生成系统会在包创建期间检查配置文件的内容，并仅保留与包中的元数据直接相关的配置文件设置。配置文件本身以及与包的元数据无关的任何配置文件设置都将从包中丢弃。
• 开发未锁定的包 包是一个顶级容器，其中包含有关应用或包的重要详细信息：包
  名称、说明和关联的命名空间。
• 推送未锁定软件包的软件包升级 通过推送升级，您可以升级订阅者组织中安装的软件包
  ，而无需要求客户自行安装升级。您可以选择哪些组织接收推送升级、将软件包升级到哪个版本以及何时进行升级。推送升级特别有用：如果您需要推送更改以修复热错误。
• 安装未锁定的软件包
  使用 CLI 或浏览器安装未锁定的软件包。您可以在临时组织、沙盒组织、DE 组织或生产组织中安装软件包版本。
• 从未锁定的包中迁移已弃用的元数据 您可以弃用未锁定包中的元数据，将该元数据移动到新包，然后在生产组织中安装新包
  。
• 卸载未锁定的软件包
  您可以使用 Salesforce CLI 或从设置 UI 从组织中卸载软件包。卸载未锁定的软件包时，软件包中的所有组件都将从组织中删除。
• 将解锁的包转移到其他开发人员中心 可以将已解锁包的所有权从一个开发人员中心组织转移到另一个开发人员中心
  组织。

什么是解锁套餐？

如果您不熟悉包装，则可以将包装视为您填充的容器 替换为元数据。它包含一组相关功能、自定义项和架构。您使用软件包 将元数据从一个 Salesforce 组织移动到另一个组织。

每个解锁的包都有不同的生命周期。将元数据添加到包中，然后创建一个 新的包版本。虽然包在不断发展，但每个包版本都是一个 不可变的工件。

包版本包含与包关联的特定元数据和功能 版本，在创建时。在循环访问包以及添加、删除或更改包时 打包的元数据，您可以创建多个包版本。

您可以在临时版、沙盒版、试用版、开发人员版或 生产组织。安装包版本与部署元数据类似。每个包装 version 有一个版本号，订阅者可以将新的软件包版本安装到他们的组织中 通过软件包升级。

注意

由于包版本是不可变的，因此它们也可以用作连续的工件 集成 （CI） 和持续交付 （CD） 流程。

您可以多次重复包开发周期。您可以更改元数据， 创建包版本，测试包版本，最后将包部署或安装到 生产组织。通过这种独特的应用开发生命周期，您可以准确控制内容、时间和内容 元数据的推出方式。在已安装的组织中，您可以检查来自哪些元数据 哪个包以及与特定包关联的所有元数据集。

基于包的开发模型

为了演示解锁包的强大功能，以下是打包在 传统发展模式。对于大多数生产组织来说，元数据传统上包含在 两个存储桶：一组从 AppExchange 安装的托管软件包，以及未打包的 元数据。

客户经常投资 Salesforce 自定义以支持业务流程和扩展 Salesforce 平台的强大功能。在开发模型中，您的 Salesforce 组织的单体 未打包的元数据包含属于自定义应用或扩展程序的所有元数据。因为 元数据不是孤立的或有组织的，可能难以理解、升级和 保持。

在包开发模型中，可以在生产中组织未打包的元数据 组织到定义良好的包中。您可以使用 Salesforce DX 项目来组织您的源 放入包目录中，所有内容都在您选择的版本控制系统中进行管理。你 最终目标是使用那些可版本控制、易于维护的目录创建包。 更新、安装和升级。

解锁的包允许您在一个或多个托管和 解锁的包，使您的包保持小巧和模块化。您可以使用命令行执行以下操作 执行未锁定的打包操作，或者您可以包含特定于打包的 Salesforce CLI 脚本中的命令，并自动执行包开发。

创建解锁包之前

使用解锁的包装时，为确保设置正确，请验证 以后。

你？

• 在组织中启用 Dev Hub
• 启用第二代托管打包
• 安装 Salesforce CLI

注意

解锁的包装可通过以下许可证获得：Salesforce 或 Salesforce Limited 访问 – 免费（仅限合作伙伴）。

使用解锁包的开发人员需要在开发人员中心设置正确的权限 组织。开发人员需要系统管理员配置文件或创建和更新 第二代包权限。有关更多信息，请参阅添加 Salesforce DX 用户。

可以从开发人员中心创建的最大解锁包版本数 Day 与您的每日 Scratch 组织分配相同。要请求提高限制， 请联系 Salesforce 客户支持。临时组织和包是分开计算的，因此创建解锁的包不计算在内 违反您的每日临时组织限制。要查看临时组织限制，请使用 CLI：

sf limits api display

欲了解更多信息 临时组织限制，请参阅临时组织。

了解您的组织

您使用解锁包装的某些组织具有独特的 目的。

选择你的 Dev Hub 组织

将 Dev Hub 组织用于这些目的。

当您使用 Salesforce CLI 创建未锁定的软件包时，您将关联该软件包 具有特定的 Dev Hub 组织。当您准备好定义和创建包时 生产使用，请务必在 生产组织。

• 作为所有已解锁软件包的所有者
• 如果要创建命名空间的未锁定包，请链接命名空间
• 授权并运行命令sf package

命名空间 Org

如果使用的是命名空间，则需要命名空间组织来获取包 命名空间。如果要严格使用命名空间进行测试，请选择 Disposable 命名空间。

创建命名空间组织并在其中指定命名空间后，打开 Dev Hub 组织，并将命名空间组织链接到 Dev Hub 组织。

其他组织

使用包时，还可以使用以下组织：

• 您可以即时创建临时组织，以便在测试软件包时使用。
• 目标组织或安装组织是安装包的位置。

创建与组织相关的未锁定包

依赖于组织的解锁包是解锁包的变体，允许您 在计划安装 软件包（安装组织）。

解开生产组织元数据可能是一个艰巨的项目。但现在你有了一个解决方案 这使您能够在不完全考虑所有元数据依赖项的情况下打包元数据： 依赖于组织的解锁包。使用与组织相关的解锁包时，元数据 验证在包安装期间进行，而不是在包版本创建期间进行。

长期和大型生产组织通常会积累大量元数据，这些元数据是 采用基于包的应用程序生命周期管理 （ALM） 时难以模块化 方法。相反，您可以将依赖于未打包元数据的元数据打包到 安装组织。

注意

依赖于组织的解锁包是解锁包的变体，而不是单独的 封装类型。它们遵循相同的软件包开发步骤，并使用 支持的元数据类型与解锁相同 包。要创建依赖于组织的解锁软件包，请指定依赖于组织的 CLI 参数 命令。

sf package create

sf package create -t Unlocked -r force-app -n MyPackage --org-dependent

要查看哪些软件包是与组织相关的解锁软件包，请使用 .sf package list –verbose

解锁包的工作流

您可以直接从 Salesforce 命令创建和安装未锁定的软件包 线。

在开始之前，请查看并完成创建解锁包之前中的步骤 此工作流。

基本工作流包括以下步骤。有关每个主题的详细信息，请参阅特定主题 步。

1. 创建 DX 项目。sf project generate --output-dir expense-manager-workspace --name expenser-app
2. 授权 Dev Hub 组织，并创建临时 组织。sf org login web --set-default-dev-hub什么时候 执行此步骤时，请包含该选项。然后，可以省略 Dev Hub username（在运行后续 Salesforce CLI 命令时）。—set-default-dev-hub提示如果您为与您合作的每个组织定义一个别名，则很容易在两者之间切换 来自命令行的不同组织。您可以授权不同的组织 循环访问包开发周期。
3. 创建一个临时组织并开发软件包。可以使用 VS Code 和安装程序 UI 在 Scratch 组织中构建和检索要包含在 包。导航到 expenser-app 目录，然后运行此 命令。sf org create scratch --definition-file config/project-scratch-def.json --target-org MyScratchOrg1
4. 验证所有包组件是否都位于要删除的项目目录中 创建包。
5. 从 Salesforce DX 项目目录中，创建包。sf package create --name "Expense Manager" --path force-app --package-type Unlocked
6. 查看 sfdx-project.json 文件。CLI 自动 更新项目文件以包含包目录，并创建基于 在包名称上。{ "packageDirectories": [ { "path": "force-app", "default": true, "package": "Expense Manager", "versionName": "ver 0.1", "versionNumber": "0.1.0.NEXT" } ], "namespace": "", "sfdcLoginUrl": "https://login.salesforce.com", "sourceApiVersion": "51.0", "packageAliases": { "Expense Manager": "0Hoxxx" } }请注意 和 的占位符值。versionNameversionNumber指定所需的功能和组织设置 对于使用外部的包中的元数据 .JSON 文件，例如临时组织定义文件。您可以在命令中指定使用标志，或列出 sfdx-project.json 文件中的定义文件。请参见： 已解锁包的项目配置文件–definition-filesf package version create
7. 创建包版本。此示例假定包元数据位于 force-app 目录中。sf package version create --package "Expense Manager" --installation-key test1234 --wait 10
8. 在临时组织中安装并测试软件包版本。使用不同的临时组织 从您在步骤中使用的那个 三。sf package install --package "Expense Manager@0.1.0-1" --target-org MyTestOrg1 --installation-key test1234 --wait 10 --publish-wait 10
9. 安装软件包后，打开 scratch 组织以查看 包。sf org open --target-org MyTestOrg1

程序包版本是 beta 版，直到将其提升为托管发布状态。请参阅：释放已解锁的软件包。

配置未锁定的软件包

在 sfdx-project.json 文件中为每个 package 来指定其别名、版本详细信息、依赖项、功能和组织设置。 在命令行中，您还可以设置或更改选项，例如指定 安装密钥、更新软件包名称或添加说明。

• 已解锁包
  的项目配置文件 项目配置文件是项目的蓝图。文件中的设置将创建包的轮廓，并确定包属性和包内容。
• 解锁的打包关键字 关键字
  是一个变量，可用于指定包版本号。
• 包安装密钥 若要确保包中元数据的安全性，必须在创建包版本时指定安装密钥
  。包创建者向授权订阅者提供密钥，以便他们可以安装包。软件包安装程序在安装过程中提供密钥，无论是从 CLI 还是从浏览器安装软件包。安装密钥是安装过程中的第一步。该密钥可确保在提供正确的安装密钥之前不会泄露任何软件包信息，例如名称或组件。
• 从未锁定的包
  中提取依赖项信息 对于已安装的未锁定包，现在可以运行简单的 SOQL 查询来提取其依赖项信息。您还可以创建一个脚本来自动安装具有依赖项的未锁定包。
• 了解命名空间 命名空间
  是一个 1-15 个字符的字母数字标识符，用于将包及其内容与组织中的其他包区分开来。
• 共享发行说明和安装后说明
  与用户共享有关已发布的解锁包中的新增功能和更改的详细信息。
• 为 Apex 测试指定未打包的元数据或 Apex 访问权限（未锁定的包）
• 解锁包的最佳实践 我们建议您在使用解锁包
  时遵循这些最佳实践。
• 已解锁包的包
  ID 和别名 在包生命周期中，包和包版本由 ID 或包别名标识。当您创建软件包或软件包版本时，Salesforce CLI 会根据软件包名称创建软件包别名，并将该名称存储在 sfdx-project.json 文件中。运行 CLI 命令或编写脚本以自动执行打包工作流时，通常更容易引用包别名，而不是包 ID 或包版本 ID。
• 常用的解锁打包操作

解锁包的项目配置文件

项目配置文件是项目的蓝图。中的设置 文件创建包的大纲并确定包属性和包 内容。

以下是可以在项目配置文件中指定的参数。

当您使用 Salesforce CLI 指定参数时，它会覆盖该值 在项目定义文件中列出。

Salesforce DX 项目定义文件是位于 您的项目。使用 CLI 命令可以 生成可基于此进行构建的项目文件。以下是参数的显示方式。sf project generatepackageDirectories

{
   "namespace": "",
   "sfdcLoginUrl": "https://login.salesforce.com",
   "sourceApiVersion": "47.0",
   "packageDirectories": [
      {
         "path": "util",
         "default": true,
         "package": "Expense Manager - Util",
         "versionName": "Winter ‘20",
         "versionDescription": "Welcome to Winter 2020 Release of Expense Manager Util Package",
         "versionNumber": "4.7.0.NEXT",
         "definitionFile": "config/scratch-org-def.json"
      },
      {
         "path": "exp-core",
         "default": false,
         "package": "Expense Manager",
         "versionName": "v 3.2",
         "versionDescription": "Winter 2020 Release",
         "versionNumber": "3.2.0.NEXT", 
         "postInstallUrl": "https://expenser.com/post-install-instructions.html",
         "releaseNotesUrl": "https://expenser.com/winter-2020-release-notes.html",
         "definitionFile": "config/scratch-org-def.json",
         "dependencies": [
            {
               "package": "Expense Manager - Util",
               "versionNumber": "4.7.0.LATEST"

            },
            {
               "package" : "External Apex Library - 1.0.0.4"
            }
         ]
      }
   ],
   "packageAliases": {
      "Expense Manager - Util": "0HoB00000004CFpKAM",
      "External Apex Library@1.0.0.4": "04tB0000000IB1EIAW",
      "Expense Manager": "0HoB00000004CFuKAM"}
}

如果我不想自动更新我的 Salesforce DX 项目怎么办？

在某些情况下，您不希望自动更新 sfdx-project.json 文件。当您需要更多控制时，请使用这些 环境变量，用于禁止对项目文件进行自动更新。

解锁的包装关键字

关键字是可用于指定包版本的变量 数。

您可以使用关键字自动递增软件包内部版本号的值， 祖先版本号，将包依赖项设置为最新版本或最新 发布和推广版本。

软件包安装密钥

若要确保包中元数据的安全性，必须指定 创建软件包版本时的安装密钥。包创建者向授权提供密钥 订阅者，以便他们可以安装包。软件包安装程序在以下期间提供密钥 安装，无论是从 CLI 还是从浏览器安装包。安装密钥 是安装过程中的第一步。该密钥确保没有包信息，例如 名称或组件，在提供正确的安装密钥之前会泄露。若要设置安装密钥，请在创建软件包版本时将参数添加到命令中。此命令创建包 并通过安装来保护它 钥匙。

–installation-key

sf package version create --package "Expense Manager" --installation-key "JSB7s8vXU93fI"

在目标组织中安装软件包版本时提供安装密钥。

sf package install --package "Expense Manager" --installation-key "JSB7s8vXU93fI”

更改现有软件包版本的安装密钥

您可以使用以下命令更改现有软件包版本的安装密钥。sf package version update

sfd package version update --package "Expense Manager@1.2.0-4" --installation-key “HIF83kS8kS7C”

创建不带安装密钥的包版本

如果不需要安全措施来保护包元数据，则可以创建一个 没有安装密钥的软件包版本。

sf package version create --package "Expense Manager" --directory common \
--tag 'Release 1.0.0' --installation-key-bypass

检查包版本是否需要安装密钥

要确定软件包版本是否需要安装密钥，请使用 或 CLI 命令。sf package version listsf package version report

从解锁的包中提取依赖项信息

对于已安装的未锁定包，您现在可以运行简单的 SOQL 查询来提取其 依赖项信息。您还可以创建一个脚本来自动安装 具有依赖项的解锁包。

SubscriberPackageVersion 工具 API 对象现在提供依赖项信息。 使用 SubscriberPackageVersion 上的 SOQL 查询，可以标识 解锁的包有一个依赖项。您可以获取 （04t） ID 和正确的 这些软件包的安装顺序。

例

包 B 依赖于包 A，包 D 依赖于包 B 和 C。 下面是你指定的示例 sfdx-project.json 创建包版本时。包 D 依赖项标记为包 A、B 和 C.

{
    "packageDirectories": [
        {
            "path": "pkg-a-workspace",
            "package": "pkgA",
            "versionName": "ver 4.9",
            "versionNumber": "4.9.0.NEXT",
            "default": true
        },
        {
            "path": "pkg-b-workspace",
            "package": "pkgB",
            "versionName": "ver 3.17",
            "versionNumber": "3.17.0.NEXT",
            "default": false,
            "dependencies": [
                {
                    "package": "pkgA",
                    "versionNumber": "3.3.0.LATEST"
                }
            ]
        },
        {
            "path": "pkg-c-workspace",
            "package": "pkgC",
            "versionName": "ver 2.1",
            "versionNumber": "2.1.0.NEXT",
            "default": false
        },
        {
            "path": "pkg-d-workspace",
            "package": "pkgD",
            "versionName": "ver 1.1",
            "versionNumber": "1.1.0.NEXT",
            "default": false,
            "dependencies": [
                {
                    "package": "pkgA",
                    "versionNumber": "3.3.0.LATEST"
                },
                {
                    "package": "pkgB",
                    "versionNumber": "3.12.0.LATEST"
                },
                {
                    "package": "pkgC",
                    "versionNumber": "2.1.0.LATEST"
                }
            ]
        }
    ],
    "namespace": "",
    "sfdcLoginUrl": "https://login.salesforce.com",
    "sourceApiVersion": "44.0",
    "packageAliases": {
        "pkgA": "0HoB00000008Oq6KAE",
        "pkgB": "0HoB00000008OqBKAU",
        "pkgC": "0HoB00000008OqGKAU",
        "pkgD": "0HoB00000008OqGKAQ"
    }
}

在安装 pkgD（ID = 04txx000000082hAAA）之前，请使用此 SOQL 查询 确定其依赖关系。用户名通常是目标订阅者组织，其中 解锁的包裹是 安装。

sf data query -u {USERNAME} -t 
   -q "SELECT Dependencies FROM SubscriberPackageVersion 
       WHERE Id='04txx000000082hAAA'" --json

运行时会看到此输出 查询，其中 pkgA、pkgB 和 pkgC 的 （04t） ID 次序。

"Dependencies":{"Ids":[
   {"subscriberPackageVersionId":"04txx000000080vAAA"},
   {"subscriberPackageVersionId":"04txx000000082XAAQ"},
   {"subscriberPackageVersionId":"04txx0000000AiGAAU"}]}

了解命名空间

命名空间是一个 1-15 个字符的字母数字标识符，用于区分包 以及组织中其他包中的内容。

指定包命名空间时，添加到包中的每个组件都具有该命名空间 作为组件 API 名称的前缀。假设您有一个名为 Insurance_Agent 的自定义对象 替换为 API 名称。如果添加此 组件添加到与 Acme 命名空间关联的包中，则 API 名称将变为 . Insurance_Agent__cAcme__Insurance_Agent__c

您可以选择创建具有或不具有特定命名空间的解锁包。命名空间 在创建包时分配给包，并且无法更改。

重要

创建命名空间时，请使用有用且信息丰富的内容 用户。但是，不要以人的名字命名命名空间（例如，通过使用人名， 昵称或私人信息）。

使用命名空间时，请牢记以下注意事项。

• 您可以使用相同的命名空间开发多个解锁包，但您可以 仅将每个包与单个命名空间相关联。
• 如果您使用多个命名空间，我们建议您为 每个命名空间。

• 创建并注册命名空间
  使用解锁的包，您可以与多个包共享单个命名空间。由于如果包共享相同的命名空间，则代码共享要容易得多，因此，如果使用 namepaces，建议对命名空间已解锁的包使用单个命名空间。
• 避免命名空间冲突
  命名空间会影响您可以在组织中安装的软件包类型的组合。
• 未锁定包
  中 Apex 类的基于命名空间的可见性 使包中的公共 Apex 可供使用相同命名空间的其他包使用。如果没有此注释，则解锁包中定义的 Apex 类、方法、接口和属性将无法被与其共享命名空间的其他包访问。声明为全局的 Apex 在所有命名空间中始终可用，并且不需要注释。@namespaceAccessible

创建并注册命名空间

使用解锁的包，您可以与多个包共享单个命名空间。因为 如果包共享相同的命名空间，则代码共享会容易得多，我们建议在 使用 Namepaces，您可以对命名空间的未锁定包使用单个命名空间。要创建命名空间，请执行以下操作：

1. 注册新的 Developer Edition 组织。
2. 在“设置”中，输入“快速查找”框，然后选择“包管理器”。Package Manager
3. 在“命名空间设置”中，单击“编辑”。
4. 输入命名空间，然后选择“检查可用性”。
5. （可选）选择要与此命名空间关联的包，或选择“无”，然后单击“查看”。
6. 查看您的选择，然后单击“保存”。

要注册命名空间，请执行以下操作：

1. 若要将创建的命名空间与开发人员中心链接，请使用命名空间注册表。请参阅链接 a 命名空间添加到 Dev Hub 中了解详细信息。
2. 在 sfdx-project.json 文件中，使用 namespace 属性。当您创建新的未锁定包时，该包是关联的 替换为 sfdx-project.json 文件中指定的命名空间。

避免命名空间冲突

命名空间会影响可以在 组织。

若要了解命名空间如何影响包的类型，可以在命名空间或 no-namespace org，请查看此表。

了解命名空间如何影响可安装到一个包中的组合 org，请查看此表。

解锁包中 Apex 类的基于命名空间的可见性

在 包可用于使用相同命名空间的其他包。如果没有此注解，Apex 无法访问未锁定包中定义的类、方法、接口和属性 与它们共享命名空间的其他包。声明为全局的 Apex 始终是 适用于所有命名空间，无需注释。

@namespaceAccessible

跨软件包的 Apex 可访问性的注意事项

• 软件包外部的 Lightning 组件可以访问已安装的公共 Apex 方法 来自无命名空间解锁的包。该组件可以从另一个组件安装 包或在组织中创建。为了访问 Apex 方法，解锁了无命名空间 包的处理方式与非托管包相同。
• 不能将注释用于 Apex 方法。@namespaceAccessible@AuraEnabled
• 您可以随时添加或删除注释，即使在托管和发布的 Apex 代码上也是如此。确保你没有 在添加或 删除它。@namespaceAccessible
• 在软件包中添加或删除 Apex 时，请考虑对安装了其他版本的用户的影响 引用此包注释的包。在推送软件包升级之前， 确保没有用户正在运行无法完全编译的包版本，当 已推送升级。@namespaceAccessible

此示例显示一个标有批注的 Apex 类。该类是可访问的 添加到同一命名空间中的其他包。第一个构造函数在 命名空间，但第二个构造函数不是。

@namespaceAccessible

// A namespace-visible Apex class
@namespaceAccessible
public class MyClass {
    private Boolean bypassFLS;

    // A namespace-visible constructor that only allows secure use
    @namespaceAccessible
    public MyClass() {
        bypassFLS = false;
    }

    // A package private constructor that allows use in trusted contexts,
    // but only internal to the package
    public MyClass (Boolean bypassFLS) {
        this.bypassFLS = bypassFLS;
    }
    @namespaceAccessible
    protected Boolean getBypassFLS() {
       return bypassFLS;
    }
}

共享发行说明和安装后说明

与您的共享有关已发布的解锁包中的新增功能和更改的详细信息 用户。

与用户共享有关已解锁包中的新增功能和更改的详细信息。您可以 指定要在用户组织的软件包详细信息页面上显示的发行说明 URL。还有你 可以通过指定安装后 URL 来共享有关使用包的说明。发布 注释和安装后 URL 显示在安装程序的“已安装的软件包”页上，之后 软件包安装成功。对于使用安装 URL 安装软件包的用户， “包安装程序”页显示指向发行说明的链接。用户被重定向到您的帖子 在成功安装或升级软件包后安装 URL。在 和 部分中指定 和 属性 包。

postInstallUrlreleaseNotesUrlpackageDirectories

"packageDirectories": [
      {
         "path": "expenser-schema",
         "default": true,
         "package": "Expense Schema",
         "versionName": ""ver 0.3.2"",
         "versionNumber": "0.3.2.NEXT",
         "postInstallUrl": "https://expenser.com/post-install-instructions.html",
         "releaseNotesUrl": "https://expenser.com/winter-2020-release-notes.html"
        },
        ],
       {
         "namespace": "",
         "sfdcLoginUrl": "https://login.salesforce.com",
         "sourceApiVersion": "47.0",
         "packageAliases": {
             "Expenser Schema": "0HoB00000004CzHKAU",
             "Expenser Schema@0.1.0-1": "04tB0000000719qIAA"
      }
}

您还可以将 和 Salesforce CLI 参数与命令一起使用。CLI 参数覆盖 sfdx-project.json 文件中指定的 URL。–post-install-url–release-notes-urlsf package version create

为 Apex 测试指定未打包的元数据或 Apex 访问权限（未锁定的包）

为包版本创建测试指定未打包的元数据

指定 sfdx-project.json 文件中未打包元数据的路径。

在此示例中，my-unpackaged-directory 中的元数据可用于 测试在TV_unl包的包版本创建期间运行。

"packageDirectories": [
    {
        "path": "force-app",
        "package": "TV_unl", 
        "versionName": "ver 0.1",
        "versionNumber": "0.1.0.NEXT",
        "default": true, 
        "unpackagedMetadata": {
            "path": "my-unpackaged-directory"
        }
    }, 
]

该属性用于元数据 那不是你包裹的一部分。不能在两个未打包的元数据中包含相同的元数据 目录和打包的目录。unpackagedMetadata

管理包版本创建测试的 Apex 访问权限

有时，您编写的 Apex 测试要求用户具有某些权限集或 权限集许可证。使用该设置可以 将权限集和权限集许可证分配给 Apex 在其上下文中测试的用户 Get 在创建包版本时运行。apexTestAccess

"packageDirectories": [
    {
        "path": "force-app",
        "package": "TV_unl", 
        "versionName": "ver 0.1",
        "versionNumber": "0.1.0.NEXT",
        "default": true, 
        "unpackagedMetadata": {
            "path": "my-unpackaged-directory"
        },
        "apexTestAccess": {
               "permissionSets": [
                   "Permission_Set_1",
                   "Permission_Set_2"
               ],
               "permissionSetLicenses": [
                   "SalesConsoleUser"
               ]
           }

    }, 
]

注意

若要分配用户许可证，请使用 runAs 方法。用户 无法在 sfdx-project.json 文件中分配许可证。

解锁包的最佳实践

我们建议您在使用解锁的软件包时遵循这些最佳实践。

• 建议仅使用一个开发人员中心，并在生产中启用开发人员中心 组织。
• 运行命令的开发人员中心组织将成为包的所有者。如果 Dev Hub 组织与 包过期或被删除，其包将不再起作用。sf package create
• 在决定如何利用命名空间时要小心。对于大多数客户，我们建议工作 没有命名空间或单个命名空间，以避免管理组件时不必要的复杂性。 如果要测试未锁定的包，请使用测试命名空间。仅在以下情况下使用实际命名空间 您已准备好踏上在生产环境中发布的开发道路 组织。注意您无法将无命名空间、未锁定的软件包安装到任何具有命名空间的组织中 （例如，具有命名空间的临时组织）。
• 在使用 和 命令时包括该选项。此选项可帮助您保持版本控制 系统标记与特定软件包版本同步。–tagsf package version createsf package version update
• 为打包 ID 创建用户友好的别名，并将这些别名包含在 Salesforce 中 DX 项目文件和运行 CLI 打包命令时。请参阅：已解锁包的包 ID 和别名。

已解锁包的包 ID 和别名

在包生命周期中，包和包版本由 ID 或 软件包别名。当您创建包或包版本时，Salesforce CLI 会创建一个包 别名，并将该名称存储在 sfdx-project.json 文件中。当您运行 CLI 命令或编写脚本时 自动化打包工作流，通常更容易引用包别名，而不是 程序包 ID 或程序包版本 ID。

包别名以名称-值的形式存储在 sfdx-project.json 文件中 对，其中名称是别名，值是 ID。您可以修改软件包别名 对于项目文件中的现有包和包版本。

在命令行中，您还可以看到包成员（一个组件 package）和请求（类似于请求）。sf package version create

注意

作为快捷方式，文档有时会通过其三个字符的前缀来引用 ID。 例如，软件包版本 ID 始终以 开头。04t

以下是最常用的 ID。

常用的解锁打包操作

有关 Salesforce CLI 打包命令的完整列表，请参阅： Salesforce 命令 线路参考指南。

我们如何处理解锁包中的配置文件设置

当您将配置文件打包到未锁定或第二代托管中时 package，构建系统会在创建包期间检查配置文件的内容，并且 仅保留与包中的元数据直接相关的配置文件设置。这 配置文件本身，以及与包元数据无关的任何配置文件设置都将从 包。

在软件包安装期间，保留的配置文件设置仅应用于现有 订阅者组织中的配置文件。配置文件本身未安装在订阅者组织中。

注意

不允许仅包含配置文件而不包含其他元数据的包，并且会失败 在包版本创建期间。

要测试打包配置文件的行为，请在临时组织中安装包。

1. 在“设置”中，输入“快速查找”框，然后找到 和 检查在软件包安装过程中选择的配置文件。Profile
2. 检查您的配置文件设置是否已应用于该配置文件。重复此步骤 对于您希望包含配置文件设置的任何其他配置文件。不要查找个人资料 您创建的名称;我们将配置文件设置应用于订阅者中的现有配置文件 组织。

尽可能使用包权限集，而不是配置文件设置。订阅者 安装包可以轻松地将权限集分配给其用户。

注意

在推送升级期间，一些与 Apex 类和字段级相关的配置文件设置 安全性不会自动分配给系统管理员配置文件。与您的沟通 客户，以确保在推送升级后正确设置用户访问权限。确保你 推送升级后查看并更新您的配置文件设置。

在未锁定的软件包中保留许可证设置

默认情况下，配置文件中的许可证设置在包创建过程中会被删除。要保留这些 settings，指定参数 在 sfdx-project.json 文件中。在此方案中，许可证设置为 保留并应用于订阅者组织中在打包期间选择的配置文件 安装。includeProfileUserLicenses

"packageDirectories": [
    {
        "package": "PackageA",
        "path": "common",
       "versionName": "ver 0.1",
       "versionNumber": "0.1.0.NEXT",
       "default": false,
       includeProfileUserLicenses: true
    }
]

编写完代码后，下一步是部署它。我们提供不同的 基于您作为客户、系统集成商或独立机构的角色和需求的部署选项 软件供应商 （ISV） 合作伙伴。

要了解不同开发模型的优势，请查看这些 Trailhead 模块：

• 确定应用程序生命周期管理模型 适合您
• 应用程序生命周期和开发模型
• 软件包开发模型
• 快速入门： 解锁套餐
• 解 锁 客户套餐

根据你的采用准备情况，请查看下表，了解建议的选项：

交付应用程序的发布选项

客户和非 ISV 合作伙伴

• 解锁包解锁的包适用于想要组织元数据的客户 到包中，并将元数据（通过包）部署到不同的组织。注意一 Unlocked Package 提供非托管包的超功能集。 因此，此列表中不包含非托管包。查看更多 信息，请参阅已解锁 包。
• 通过 Salesforce CLI 更改集或组织开发

ISV 合作伙伴

• 第二代托管软件包如果你是开发应用并列出应用的 ISV 在 AppExchange 上，Salesforce 建议使用托管软件包。第二代托管 打包（托管 2GP）为 AppExchange 合作伙伴开创了一种新的开发方式， 分发和管理他们的应用和元数据。您可以使用托管的 2GP 来组织 源代码，构建小型模块化软件包，与您的版本控制系统集成，以及 更好地利用您的自定义 Apex 代码。您可以通过以下方式执行所有打包操作 Salesforce CLI，或使用脚本自动执行它们。有关托管的更多信息 2GP 封装，参见第二代 托管打包开发人员指南。
• 第一代托管软件包与托管 2GP 类似，使用托管 1GP 包 由 ISV 通过 AppExchange 将其业务应用程序分发给客户。如果你是 熟悉第一代托管软件包，并希望详细了解 1GP 如何 与 2GP 不同，请参阅 First- 和 第二代托管包。有关托管 1GP 的更多信息 软件包，请参阅创建第一代托管 使用 Salesforce DX 打包。

还没准备好进行软件包开发？

如果你或你的团队尚未准备好进行包开发，则可以继续使用更改 设置，或尝试使用组织开发模型，在该模型中，您可以使用 Salesforce CLI 部署更改。 有关更多信息，请参阅使用元数据 API 构建和发布您的应用程序。

• 使用元数据 API
  构建和发布应用 在沙盒中开发和测试应用。使用 Salesforce CLI 或 Salesforce Extensions for VS Code 检索和部署源。此开发工作流称为组织开发模型。

使用元数据 API 构建和发布应用

在沙盒中开发和测试应用。使用 Salesforce CLI 或 Salesforce 扩展 让 VS Code 检索和部署源。此开发工作流称为组织 发展模式。

使用组织开发模型在沙盒中进行开发和测试

与更改集类似，发布工件是一组要在 生产组织。您可以使用这些命令开发、测试和部署更改。如果您想了解更多相关信息 开发模型，请参阅 Trailhead 中的组织开发模型模块。project deploy

开发和发布环境

1. 开发和测试：每个团队成员都有自己的开发人员沙盒 创建他们分配的自定义项。开发人员沙盒不包含生产数据。
2. 内部版本：每个团队成员都从他们的 将相应的 Developer 沙箱连接到共享的 Developer Pro 沙箱以进行集成。开发人员专业版 沙盒不包含生产数据，但您可以使用测试数据为沙盒设定种子。
3. 测试版本：对于用户验收测试，团队使用部分沙盒 以创建生产的完整副本。
4. 释放：在发布投入生产后，团队可以使用完整沙盒来执行以下操作 培训用户，避免更改生产数据的风险。完整沙盒包括 生产数据。

我需要什么工具？

部署 Apex Code 的注意事项

要将 Apex 部署到生产环境，Apex 代码的单元测试必须满足覆盖率要求。 代码覆盖率指示类和触发器中有多少行可执行代码 由您的测试方法涵盖。编写测试方法来测试触发器和类，然后运行 这些测试来生成代码覆盖率信息。如果在启动部署时未指定测试级别，则默认测试执行 行为取决于部署包的内容。

• 如果您的部署包包含 Apex 类或触发器，则当您部署到 生产中，将执行所有测试，但源自托管包的测试除外。
• 如果您的包不包含 Apex 代码，则默认情况下不会运行任何测试。

您可以为非 Apex 组件的部署运行测试。您可以覆盖默认测试 通过在部署选项中设置测试级别来执行行为。测试级别为 无论部署包中存在的组件类型如何，都会强制执行。我们建议 在开发环境（如沙盒）中运行所有本地测试之前 部署到生产环境。在开发环境中运行测试可减少 生产部署中所需的测试。

• 在本地
  开发和测试更改 以源格式开发更改，部署到开发人员沙盒并从中检索。
• 构建和测试发布项目 在您的团队完成其开发任务
  后，过渡到构建发布阶段，以将您的更改集成到 Developer Pro 沙盒中。然后生成发布项目。
• 在暂存环境中
  测试发布项目 暂存更改并在完整沙盒中运行回归测试。
• 将应用发布到生产环境 现在，所有测试都已在完整沙盒中通过，可以部署到生产环境
  了。
• 取消元数据部署
  您可以从 Salesforce CLI 取消元数据部署，并指定命令完成的等待时间。

在本地开发和测试更改

对源代码格式进行更改，部署到开发人员并从开发人员处检索 沙盒。

这些步骤提供了高级工作流。

1. 创建源代码管理存储库。
2. 创建DX项目。
3. 将 DX 项目文件添加到源代码管理存储库。
4. 授权开发人员沙盒。
5. 在开发人员沙盒中执行开发任务。
6. 从开发人员沙盒中检索更改。如果您有一些更改，您可以 指示以逗号分隔的元数据组件名称列表。如果您有很多更改，则可以 使用清单 （package.xml）。sf project retrieve start --manifest path/to/package.xml
7. 将更改提交到源代码管理存储库。

下一个：部署团队对 Developer Pro 沙盒所做的所有更改，然后进行测试 这些变化。

生成并测试发布项目

在您的团队完成其开发任务后，过渡到内部版本 阶段，将您的更改集成到 Developer Pro 沙盒中。然后生成版本 人工制品。

下面是工作流中用于创建发布项目的高级步骤。

1. 从存储库中提取更改，以便本地项目包含团队拥有的所有更改 䍬。
2. 授权 Developer Pro 沙盒。
3. 运行 deploy 命令，该命令模拟将部署到生产环境的内容，例如：sf project source deploy --manifest manifest/package.xml --target-org dev-pro-sandbox \ --test-level RunSpecifiedTests --tests TestMyCode
4. 打开沙盒。
5. 执行测试。
6. 如果测试通过，请继续执行部署版本的测试发布阶段 项目添加到部分沙箱中。然后执行用户验收测试。

测试通过后，进入发布阶段，在完整版中执行回归测试 沙盒。

在暂存环境中测试发布项目

暂存更改并在完整模式下运行回归测试 沙盒。

根据集成测试进行所有更改后，下一步 是在完整沙盒中暂存更改。将更改部署到 完整沙盒类似于用于将更改部署到开发人员的过程 专业沙盒。此阶段包括回归测试，并模拟您发布 对生产的更改。

这些步骤提供了高级工作流。

1. 授权完整沙盒。
2. （可选）如果您根据 Developer Pro 中的测试进行了任何更改 沙盒中，创建发布工件 （.zip）。如果没有，请使用 现有发布项目。
3. 要在不将组件保存在目标组织中的情况下验证部署，请运行 所有本地（回归）测试。通过验证，可以验证 将在部署期间执行但不提交任何测试 变化。sf project deploy validate --manifest manifest/package.xml --target-org full-sandbox --test-level RunLocalTests
4. 在暂存沙盒中测试实际的生产部署步骤。设置 您计划针对生产组织执行的相同快速部署。sf project deploy validate --manifest manifest/package.xml --target-org full-sandbox --test-level RunSpecifiedTests这 命令返回您在快速部署中引用的作业 ID。
5. 接下来，使用上一个中返回的作业 ID 测试快速部署 步。sf project deploy quick --target-org full-sandbox --job-id jobID

验证部署后，您有 10 天的时间来执行快速部署到 生产。

将应用发布到生产环境

现在，所有测试都已通过完整沙盒，可以部署到 生产。

1. 在部署运行列表中，完成所有部署前任务。
2. 授权您的生产组织。
3. 通过验证部署来设置快速部署。sf project deploy validate --source-dir force-app --target-org prod-org --testlevel RunLocalTests此命令返回您在快速部署中引用的作业 ID。
4. 运行测试后，验证所有 Apex 测试是否都已通过。确保 测试至少覆盖了 75% 的部署代码。
5. 运行快速部署：sf project deploy quick --target-org prod-org --job-id jobID
6. 打开生产组织，然后执行 部署运行列表。

取消元数据部署

您可以从 Salesforce CLI 取消元数据部署，并指定 命令完成。

要取消最近的部署，请运行 。可以通过使用标志指定 想要取消。project deploy cancel –use-most-recent–job-id <JOBID>

sf project deploy cancel --job-id <jobid>

cancel 命令完成并在 终端窗口为 33 分钟。如果命令在等待期结束时未完成， CLI 将终端窗口的控制权交还给您。您可以根据需要调整等待时间 通过指定标志中的分钟数， 如以下示例所示：–wait

sf project deploy cancel --wait 20 --use-most-recent

对已取消部署的状态感到好奇？运行部署报告。

sf project deploy report --use-most-recent

导入一些测试数据后，您就完成了设置项目的过程。 现在，您可以开始开发过程了。

从 CLI 创建源文件

要从 CLI 添加源文件，请确保您在适当的 目录。例如，如果您的软件包目录名为 force-app，请在 force-app/main/default/classes 中创建 Apex 类。您可以根据需要组织源 在每个包目录下，文档、自定义对象和自定义对象除外 翻译。

从 API 版本 45.0 开始，您可以使用两种编程模型构建 Lightning 组件： Lightning Web 组件和 Aura 组件。要组织组件的源文件， 您的 Aura 组件必须位于 aura 目录中。您的闪电网络 组件必须位于 LWC 目录中。

执行以下命令之一。

• apex generate class
• apex generate trigger
• cmdt generate object
• cmdt generate field
• cmdt generate record
• cmdt generate records
• cmdt generate fromorg
• lightning generate app
• lightning generate component
• lightning generate event
• lightning generate interface
• lightning generate test
• schema generate sobject
• schema generate field
• schema generate platformevent
• schema generate tab
• static-resource generate
• visualforce generate component
• visualforce generate page

许多命令都具有以下两个有用的可选标志：

提示

如果您想了解有关命令的详细信息，请使用标志运行该命令。例如。–helpsf apex generate class –help

编辑源文件

使用您喜欢的代码编辑器编辑 Apex 类、Visualforce 页面和 组件、Lightning Web 组件和 Aura 组件。您可以 还可以在组织的设置 UI 中进行编辑，然后用于检索对项目的这些更改。为 组织中已有的 Lightning 页面（FlexiPage 文件），请使用快捷方式 从默认浏览器在临时组织中打开 Lightning App Builder。闪电 页面存储在 flexipages 目录中。project retrieve start

在默认浏览器中编辑 FlexiPage，例如，编辑 Property_Record_Page source – 从 FlexiPages 目录执行此命令。

sf org open --source-file Property_Record_Page.flexipage-meta.xml

如果要生成在 Lightning 应用程序生成器中加载 .flexipage-meta.xml 文件但不启动的 URL 您的浏览器，请使用该标志。–url-only | -r

sf org open --source-file Property_Record_Page.flexipage-meta.xml --url-only

• 针对任何组织进行开发 针对启用了源跟踪的临时或沙盒组织
  进行开发后，您最终会在非源跟踪组织中测试和验证更改。
• 分配权限集
  创建临时组织并部署源后，有时必须授予用户访问应用程序的权限，尤其是在应用程序包含自定义对象的情况下。
• 向组织添加数据的方法 组织
  进行开发需要一小组库存数据进行测试。
• 创建 Lightning 应用程序和 Aura 组件 您可以使用 Salesforce CLI 在本地 Salesforce DX 项目中创建 Lightning 应用程序和 Aura 组件
  。生成的文件位于项目的包目录中。aura
• 创建 Lightning Web 组件 您可以使用 Salesforce CLI 在本地 Salesforce DX 项目中创建 Lightning Web 组件
  。生成的文件位于项目包目录中的目录中。lwc
• 创建 Apex 类 您可以使用 Salesforce CLI 在本地 Salesforce DX 项目中创建 Apex 类
  。生成的类文件位于项目的包目录中。classes
• 创建 Apex 触发器 使用 Apex 触发器
  在更改 Salesforce 记录之前或之后执行自定义操作，例如插入、更新或删除。您可以使用 Salesforce CLI 在本地 Salesforce DX 项目中创建 Apex 触发器。生成的文件位于项目包目录中的目录中。triggers
• 创建自定义对象
  您可以使用 Salesforce CLI 为本地 Salesforce DX 项目中的新自定义对象生成元数据文件。
• 执行匿名 Apex 您可以使用 Salesforce CLI 命令在组织中执行匿名的 Apex
  代码块。apex run
• 运行 Apex 测试 当您准备好测试对源代码的更改时，您可以在命令行上使用 Salesforce CLI 在组织中运行 Apex 测试
  。您还可以从 Salesforce Extensions for VS Code 或第三方持续集成工具（如 Jenkins 或 CircleCI）中运行 Apex 测试。

针对任何组织进行开发

针对启用了源跟踪的临时或沙盒组织进行开发后，您 最终在非源跟踪组织中测试和验证您的更改。

您可以使用 Salesforce CLI 检索元数据并将其部署到 非源跟踪组织，与检索和部署源（在源中）一样容易 format） 到从头开始组织。如果您不熟悉 Salesforce CLI、Salesforce DX 项目结构和 源文件格式解释了源格式和元数据之间的区别 格式。

使用 ，您可以检索 您需要的元数据以源格式发送到本地文件系统（DX 项目）。当您的更改 已准备好进行测试或生产，您可以使用本地文件直接部署到非源代码跟踪的组织。project retrieve startproject deploy start

不确定支持哪些元数据类型或哪些元数据类型支持通配符？请参阅元数据 API Developer 中的元数据类型 指南。package.xml

准备工作

在开始之前，请不要忘记：

• 创建包含清单 （package.xml） 的 Salesforce DX 项目。跑。project generate –name mywork MyProject –manifest
• 授权您的非源跟踪组织。如果连接到沙盒，请先编辑 sfdx-project.json 文件以设置为 https://test.salesforce.com 授权组织。不要忘记为您的创建别名 非源跟踪组织。sfdcLoginUrl

需要在命令行上编码的元数据名称

使用该选项检索或部署元数据时，元数据名称中的逗号需要编码才能正常工作。–metadata

不要： sf project deploy start –metadata “Profile:Standard User” –metadata “Layout:Page,Console”

狐狸 sf project deploy start –metadata “Profile:Standard User” –metadata “Layout:Page%2CConsole”

从非源跟踪组织中检索源

使用命令检索 来自没有源跟踪的组织（例如沙盒或生产组织）的源。 如果您在 VCS 中已有源代码和元数据，则可以跳过此操作 步。如果要重新开始，请检索与该功能关联的元数据。 项目或您正在处理的自定义项。project retrieve start

您可以使用以下方法之一检索源格式的元数据：

• 指定列出要检索的组件的 package.xml。
• 指定以逗号分隔的元数据组件名称列表。
• 指定要检索的源文件路径的逗号分隔列表。您可以使用源 path 选项，当 source 存在于本地时，例如，在完成初始 取回。
• 指定以逗号分隔的包名称列表。

如果您提供的逗号分隔列表包含空格，请将整个 一组双引号中的逗号分隔列表。

检索元数据时只能指定一个范围参数：、 或 。如果指明 ，则可以包括一个附加 作用域参数。–metadata–source-dir–manifest–package-name

sf project retrieve start --package-name DreamHouse --manifest manifest/package.xml

将源部署到非源跟踪组织

使用命令部署源 到没有源跟踪的组织，例如沙盒或生产组织。project deploy start

您可以使用以下方法以源格式部署元数据：

• 指定列出要部署的组件的包 .xml
• 指定以逗号分隔的元数据组件名称列表
• 指定要部署的源文件路径的逗号分隔列表

如果您提供的逗号分隔列表包含空格，请将整个 一组双引号中的逗号分隔列表。

删除未跟踪的来源

使用命令删除 来自没有源跟踪的组织（例如沙盒）的组件。project delete source

如果源本地存在于 DX 项目中，您可以通过指定 源的路径或列出单个元数据组件的路径。如果以逗号分隔的列表 您提供的包含空格，将整个逗号分隔的列表包含在一组 双引号。

是否要保留生成的元数据？

通常，当您运行某些 CLI 命令时，包含所有元数据的临时目录是 创建，然后在成功完成命令后删除。但是，保留这些 由于多种原因，文件可能很有用。您可以调试命令期间出现的问题 执行。运行时可以使用生成的包.xml 后续命令，或作为创建包含所有 您关心的元数据。

要在运行这些命令时将所有元数据保留在指定的目录路径中，请将 SF_MDAPI_TEMP_DIR环境变量：

• project deploy start
• project retrieve start
• project delete source
• project convert mdapi|source
• org create scratch（如果您的 Scratch 组织定义 包含临时组织设置，而不是组织首选项）

例：

SF_MDAPI_TEMP_DIR=/users/myName/myDXProject/metadata

分配权限集

在创建临时组织并部署源代码后，有时必须将 用户访问您的应用程序，尤其是在您的应用程序包含自定义对象时。

1. 如果需要，请在临时组织中创建权限集。
   1. 在浏览器中打开临时组织。sf org open --target-org <scratch org username/alias>
   2. 在“设置”中，在“快速查找”框中输入“Perm”，然后选择“权限集”。
   3. 单击“新建”。
   4. 输入权限集的描述性标签，然后单击“保存”。
   5. 在“应用”下，单击“分配的应用”|”编辑。
   6. 在“可用应用”下，选择你的应用，然后点按“添加”以移动它 添加到已启用的应用程序。
   7. 点击保存。
2. 从临时组织检索到项目的权限集。sf project retrieve start --target-org <scratch org username/alias>
3. 将权限集分配给包含应用的组织中的一个或多个用户：sf org assign permset --name <permset_name> --target-org <username/alias>目标用户名必须具有分配权限集的权限。使用标志将权限集分配给 非管理员用户。–on-behalf-ofsf org assign permset --name <permset_name> --target-org <admin-user> --on-behalf-of <non-admin-user>

您还可以使用该命令将权限集许可证分配给用户。它的工作方式与命令类似。

org assign permsetlicenseorg assign permset

向组织添加数据的方法

开发组织需要一小组库存数据进行测试。

有时，临时组织中的库存数据无法满足您的开发需求。 Apex 测试通常会创建自己的数据。因此，如果 Apex 测试是 只测试您在临时组织运行的测试，您可能不需要担心 关于数据暂时。但是，其他测试（如 UI、API 或 用户验收测试，确实需要基线数据。确保您使用 运行每种类型的测试时一致的数据集。

以下各节介绍了可用于 填充您的组织。您使用的命令取决于您当前阶段的 发展。

您还可以使用 CLI 命令 对组织运行 SOQL 查询。虽然该命令不会更改 组织中的数据，它对于搜索或计算数据很有用。您还可以 将其与其他数据操作命令一起使用。请参阅 SOQL 和 SOSL 参考指南，了解使用这些命令时也适用的一般 SOQL 限制。data query

临时组织的注意事项

Scratch 组织附带的数据集与 他们是基于的。例如，Developer Edition 组织通常 包括 10-15 条关键标准对象的记录，例如 Account、 联系和领导。当您进行测试时，这些记录会派上用场 类似于新触发器、工作流规则、闪电网络之类的东西 组件、Aura 组件或 Visualforce 页面。

数据导出 | 导入树命令

SObject Tree Save API 驱动用于导出和 导入数据。这些命令使用 JSON 文件来描述对象和 关系。该命令需要 SOQL 查询来选择组织中的数据 写入 JSON 文件。而不是加载每个记录的所有记录 键入并建立关系，该命令将加载父项和子项 已经在层次结构中。data export|import treedata exportdata import

注意

这些命令旨在供开发人员使用小型 数据。导出查询最多可以返回 2000 条记录。 要导入的文件最多可以有 200 条记录。

数据删除 | 更新插入批量命令

批量 API 2.0 驱动用于从 组织并将该数据存储在源代码管理中。然后，您可以更新或 直接扩充数据，而不是在数据来源的组织中扩充数据。 这些命令使用 CSV 文件将数据文件导入临时组织或 删除您不想再挂在身边的数据集。使用点 用于建立孩子与父母关系的符号。data delete|upsert bulkdata delete|upsert bulk

数据创建 | 删除 | 获取 record 命令

每个人的流程都是独一无二的，您并不总是需要与 你的队友。当您想要创建、修改或删除时 使用命令快速记录单个记录。无数据文件 是需要的。data create|delete|get record

• 示例：在组织之间导出和导入数据
  假设您已经创建了一组完美的数据来测试您的应用程序，并且它当前驻留在临时组织中。您在第二个临时组织中完成了新功能的编码，推送了源代码，并分配了所需的权限集。现在，您想用来自其他组织的完美数据集来填充临时组织。 如何？请继续阅读！

示例：在组织之间导出和导入数据

假设您已经创建了一组完美的数据来测试您的应用程序，并且它 当前驻留在临时组织中。您在第二个临时组织中完成了对新功能的编码， 推送源代码，并分配所需的权限集。现在，您要填充 使用来自其他组织的完美数据集来临时组织。 如何？请继续阅读！

虽然这个例子有点做作，但它对于获得一些实践经验很有用 替换为 data 命令。该示例引用了 Broker 和 Properties 自定义对象 GitHub 上的 Salesforce DreamHouse LWC 应用程序示例。比方说 要从中导出数据的临时组织具有别名 。同样，您想要进入的临时组织 要导入的数据具有别名 。对于临时组织，假设您有 已经：org-with-dataorg-needs-dataorg-with-data

• 通过部署 DreamHouse 创建了 Broker 和 Properties 自定义对象 源。
• 已分配权限集。
• 用数据填充对象。

然而，对于临时组织来说，它是 假定您已经创建了 Broker 和 Properties 对象并分配了权限 设置但尚未用数据填充对象。org-needs-data

有关这些先决条件任务的说明，请参阅 GitHub 存储库中的自述文件。dreamhouse-lwc

1. 从“带数据的组织”临时数据中导出数据 组织。使用命令微调 SELECT 查询，以便返回要导出的确切数据集。此命令输出 结果发送到终端或命令窗口，但不会生成任何文件。data query注意由于 SOQL 查询很长，因此示例命令用反斜杠分隔 更容易阅读。您仍然可以将命令复制并粘贴到终端窗口中，然后 运行它。sf data query --target-org org-with-data --query \ "SELECT Id, Name, Title__c, Phone__c, Mobile_Phone__c, \ Email__c, Picture__c, \ (SELECT Name, Address__c, City__c, State__c, Zip__c, \ Price__c, Beds__c, Baths__c, Picture__c, \ Thumbnail__c, Description__c \ FROM Properties__r) \ FROM Broker__c"
2. 当您对 SELECT 语句感到满意时，请使用它将数据导出到集合中 的 JSON 文件，使用 data export tree 命令。sf data export tree --target-org org-with-data --query \ "SELECT Id, Name, Title__c, Phone__c, Mobile_Phone__c, \ Email__c, Picture__c, \ (SELECT Name, Address__c, City__c, State__c, Zip__c, \ Price__c, Beds__c, Baths__c, Picture__c, \ Thumbnail__c, Description__c \ FROM Properties__r) \ FROM Broker__c" \ --prefix export-demo --output-dir sfdx-out --plan该命令写入 JSON 文件 添加到 sfdx-out 目录和前缀 文件名替换为字符串 。文件 包括计划定义文件，该文件引用包含数据的其他文件， 每个导出的对象（Broker 和 Properties）对应一个对象。data export treeexport-demo
3. 将数据导入 org-needs-data 暂存 组织，通过指定计划定义文件到数据导入 tree 命令。sf data import tree --target-org org-needs-data \ --plan sfdx-out/export-demo-Broker__c-Property__c-plan.json使用参数指定完整路径 命令生成的计划执行文件的名称。计划执行文件名始终以 -plan.json 结尾。–plandata export tree

例

寻找更复杂的示例？easy-spaces-lwc 示例应用程序有一个数据计划，显示如何导入帐户、相关 联系人和 3 级深度自定义对象链。

创建 Lightning 应用程序和 Aura 组件

您可以使用 Salesforce CLI 在本地创建 Lightning 应用程序和 Aura 组件 Salesforce DX 项目。生成的文件位于项目的包目录中。

aura

1. 打开终端（macOS 和 Linux）或命令提示符 Windows，然后切换到 Salesforce DX 项目目录。
2. 在要生成 Lightning 应用程序和 Aura 组件。例如，如果要在默认 package 目录下，如果不存在，请创建 force-app/main/default/aura 目录。
3. 创建 Lightning 应用程序或 Aura 组件;使用 –name 标志指定应用或组件名称，并使用 —output-dir 标志指定 AURA 目录。sf lightning generate app --name myApp --output-dir force-app/main/default/aurasf lightning generate component --type aura --name myAuraComponent --output-dir force-app/main/default/aura

使用命令部署新的 Lightning 应用程序和 Aura 组件添加到您的组织。project deploy start

sf project deploy start --metadata AuraDefinitionBundle:myApp --metadata AuraDefinitionBundle:myAuraComponent

创建 Apex 类

您可以使用 Salesforce CLI 在本地 Salesforce DX 项目中创建 Apex 类。 生成的类文件位于 package 目录。

classes

1. 打开终端（macOS 和 Linux）或命令提示符 Windows，然后切换到 Salesforce DX 项目目录。
2. 在要生成 顶点类。例如，如果要在默认包目录中生成它，请创建 force-app/main/default/classes 目录（如果没有） 存在。
3. 创建 Apex 类;使用 –name 标志指定类名，使用 —output-dir 标志指定类目录。sf apex generate class --name myClass --output-dir force-app/main/default/classes

该命令生成两个文件：

• myClass.cls-meta.xml– 元数据文件
• myClass.cls– Apex 源文件

默认情况下，该命令创建一个空的 Apex 类。但是，您可以选择不同的 模板，具体取决于您正在创建的内容，通过指定标志。–template

本示例选择模板。ApexException

sf apex generate class --name myException --template ApexException --output-dir force-app/main/default/classes

使用命令部署新的 Apex 类添加到您的组织。project deploy start

sf project deploy start --metadata ApexClass:myClass

创建 Apex 触发器

使用 Apex 触发器在更改 Salesforce 之前或之后执行自定义操作 记录，例如插入、更新或删除。您可以使用 Salesforce CLI 创建 Apex 本地 Salesforce DX 项目中的触发器。生成的文件位于 项目。

triggers

1. 打开终端（macOS 和 Linux）或命令提示符 Windows，然后切换到 Salesforce DX 项目目录。
2. 在要生成 顶点触发器。例如，如果要在默认包目录中生成它，请创建 force-app/main/default/triggers 目录，如果 不存在。
3. 生成 Apex 触发器;使用 –name 标志指定触发器名称，使用 —output-dir 标志指定触发器目录。sf apex generate trigger --name myTrigger --output-dir force-app/main/default/triggers默认情况下，生成的触发器用于泛型 sObject 上的事件。使用 and 标志更改这些 默认值。此示例生成一个触发器，该触发器在插入 Account 对象。before insert–event–sobjectsf apex generate trigger --name myTrigger --event 'before insert,after insert' --sobject Account --output-dir force-app/main/default/triggers

该命令生成两个文件。

• myTrigger.trigger-meta.xml– 元数据文件
• myTrigger.trigger– Apex 触发器源文件

使用命令部署新的 组织的顶点触发器。project deploy start

sf project deploy start --metadata ApexTrigger:myTrigger --target-org myscratch

创建自定义对象

您可以使用 Salesforce CLI 为本地 Salesforce DX 项目中的新自定义对象生成元数据文件。

1. 打开终端（macOS 和 Linux）或命令提示符 Windows，然后切换到 Salesforce DX 项目目录。
2. 运行交互式架构生成 sobject 命令。您必须为新的自定义指定标签 带有 –label 标志的对象。命令 使用此标签为其他对象属性提供智能建议， 例如其 API 名称和复数标签。sf schema generate sobject --label "New Object"回答有关新对象的所有问题，例如生成文件在 您的 Salesforce DX 项目以及是否启用各种对象属性。

创建自定义对象后：

• 使用交互式命令在新对象上创建自定义字段，该命令会生成 项目中必需的元数据文件。您还可以使用以下命令 在标准对象（如 Account）上创建自定义字段。schema generate field
• 使用命令为新对象创建自定义选项卡。schema generate tab

然后，将新的自定义对象部署到您的组织。

sf project deploy start --metadata CustomObject:NewObject__c --target-org myscratch

这 首次将新的自定义对象部署到源跟踪组织时，组织 创建其他属性并设置新的默认值。出于这个原因，我们 建议立即检索自定义对象，以便检索本地源文件 已更新为新信息。

执行匿名 Apex

您可以使用 Salesforce CLI 命令在组织中执行匿名的 Apex 代码块。

apex run

1. 打开终端（macOS 和 Linux）或命令提示符 Windows，然后切换到 Salesforce DX 项目目录。
2. 运行不带标志的 apex run 命令以打开 交互式 shell。在提示符下，输入所有 Apex 代码;完成后按 CTRL-D。 然后，您的代码将在指定组织中的单个执行匿名请求中执行，或者 默认组织（如果未指定）。sf apex run --target-org myscratch此输出显示了执行 Apex 代码的示例system.debug (‘Hello world!’);

Start typing Apex code. Press the Enter key after each line, then press CTRL+D when finished.
system.debug (‘Hello world!’);
Compiled successfully.
Executed successfully.

58.0 APEX_CODE,DEBUG;APEX_PROFILING,INFO
Execute Anonymous: system.debug (‘Hello world!’);
14:23:06.174 (174742273)|USER_INFO|[EXTERNAL]|0058H000005QWcE|test-ux9lpg9jyyqt@example.com|(GMT-07:00) Pacific Daylight Time (America/Los_Angeles)|GMT-07:00
14:23:06.174 (174785450)|EXECUTION_STARTED
14:23:06.174 (174792639)|CODE_UNIT_STARTED|[EXTERNAL]|execute_anonymous_apex
14:23:06.174 (175417814)|USER_DEBUG|[1]|DEBUG|Hello world!
14:23:06.175 (175529797)|CUMULATIVE_LIMIT_USAGE
14:23:06.175 (175529797)|LIMIT_USAGE_FOR_NS|(default)|
Number of SOQL queries: 0 out of 100
Number of query rows: 0 out of 50000
Number of SOSL queries: 0 out of 20
Number of DML statements: 0 out of 150
Number of Publish Immediate DML: 0 out of 150
Number of DML rows: 0 out of 10000
Maximum CPU time: 0 out of 10000
Maximum heap size: 0 out of 6000000
Number of callouts: 0 out of 100
Number of Email Invocations: 0 out of 10
Number of future calls: 0 out of 50
Number of queueable jobs added to the queue: 0 out of 50
Number of Mobile Apex push calls: 0 out of 10

14:23:06.175 (175529797)|CUMULATIVE_LIMIT_USAGE_END

14:23:06.174 (175598235)|CODE_UNIT_FINISHED|execute_anonymous_apex
14:23:06.174 (175617689)|EXECUTION_FINISHED

使用标志执行 Apex 在文件中编码，而不是以交互方式编写代码。–file

sf apex run --file ~/test.apex

运行 Apex 测试

当您准备好测试对源代码的更改时，您可以在组织中运行 Apex 测试 在命令行上使用 Salesforce CLI。您还可以从 Salesforce Extensions 运行 Apex 测试 适用于 VS Code 或第三方持续集成工具，例如 Jenkins 或 CircleCI 中。

所需的最低用户权限和设置

运行 Apex 测试的用户必须在组织中具有以下用户权限：

• View 设置和配置
• API 已启用

此外，请确保在组织的用户界面中启用了“启用流式处理 API”设置。 默认情况下，该设置处于启用状态。

有关详细信息，请参阅用户权限和配置用户界面设置。

运行所有 Apex 测试并查看结果

此命令异步运行指定组织中的所有 Apex 测试，这是默认设置 行为。

sf apex run test --target-org myscratch

该命令不会显示实际测试结果，而是输出带有作业 ID 的命令，然后运行该 ID 进行查看 完整的结果。例如：apex get test

sf apex get test --test-run-id 7078HzRMVV --target-org myscratch

使用该标志同步运行测试。 该命令将等待显示测试结果，直到所有测试完成。–synchronous

sf apex run test --synchronous

运行特定的 Apex 测试

用于运行测试的子集。请参阅了解 Apex Developer 中的部署 可能的测试级别值列表指南。–test-level

sf apex run test --test-level RunLocalTests

使用标志列出要运行的测试类或套件、指定输出格式、查看代码 覆盖结果等。例如，以下命令运行 TestA 和 TestB 测试 类，以 Test Anything Protocol （TAP） 格式提供结果，并请求代码覆盖率 结果。测试在默认组织中运行。

sf apex run test --class-names TestA --class-names TestB --result-format tap --code-coverage

使用标志运行特定的测试方法 使用标准符号 .如果你是 测试托管软件包，请使用 . 如果指定一个没有方法的测试类，则该命令将运行该类中的所有方法。 此示例演示如何运行类中的两个方法以及类中的所有方法。–testsClass.methodnamespace.Class.methodTestATestB

sf apex run test --tests TestA.excitingMethod --tests TestA.boringMethod --tests TestB

下面是相同的示例，但具有命名空间。

sf apex run test --tests ns.TestA.excitingMethod --tests ns.TestA.boringMethod --tests ns.TestB

您可以指定 OR FOR 或两者，但不能同时指定两者。–tests–class-namesapex run test

• 调试 Apex 如果您使用 Salesforce Extensions for Visual Studio Code （VS Code） 执行开发任务，则可以选择 Apex
  调试器扩展。无论您选择哪种调试器，您都可以在 Apex 类中设置断点并逐步执行它们，以实时检查您的代码以查找错误。可以在 VS Code 中或在命令行上运行 Apex 测试。
• 生成和查看 Apex 调试日志 Apex 调试日志
  可以记录在任何经过身份验证的组织中执行事务或运行单元测试时发生的数据库操作、系统进程和错误。在适用于 VS Code 的 Salesforce 扩展中启用调试日志，然后使用 VS Code 或 Salesforce CLI 查看日志。

调试 Apex

如果您使用 Salesforce Extensions for Visual Studio Code （VS Code） 进行开发 任务，您可以选择 Apex Debugger 扩展。无论选择哪个调试器，都可以设置 Apex 类中的断点，并逐步执行它们以实际检查代码 是时候找到错误了。可以在 VS Code 中或在命令行上运行 Apex 测试。

Apex 重播调试器

Apex Replay Debugger 无需任何额外许可证即可使用。配置和 使用它，请参阅 Apex Replay Debugger。

Apex 交互式调试器

您的 Dev Hub 组织中必须至少有一个可用的 Apex Debugger 会话。购买 组织的更多会话，请联系您的系统管理员以打开案例。

• Performance Edition 和 Unlimited Edition 组织包括一个 Apex Debugger 会话。
• Apex 调试器会话在试用版和开发人员版组织中不可用。
• 您可以为 Enterprise Edition 组织购买 Apex Debugger 会话。

通过将功能添加到临时组织定义文件，在临时组织中启用 Apex 调试器：DebugApex

"features": "DebugApex"

要配置和使用它，请参阅 Apex 交互式调试器。

ISV Debugger (Salesforce Extensions for VS Code Only)

ISV Customer Debugger 是 Apex Interactive Debugger （） 扩展的一部分，因此您不必安装 除 Salesforce 扩展包及其先决条件之外的任何内容。您只能调试 沙盒组织。salesforcedx-vscode-apex-debugger

请参阅 Salesforce Extensions 中的 ISV 客户调试器 VS Code 了解详细信息。

生成和查看 Apex 调试日志

Apex 调试日志可以记录数据库操作、系统进程和发生的错误 在任何经过身份验证的组织中执行事务或运行单元测试时。启用调试日志 ，然后使用 VS Code 或 Salesforce 查看日志 命令行界面。

1. 在 Salesforce Extensions for VS Code 中，准备组织以生成日志并配置 调试器。
   1. 登录到组织。
   2. 对于 Replay Debugger，请运行 SFDX： Turn on Apex Debug Log for Replay 调试器。
   3. 为重播调试器或交互式调试器创建启动配置文件。
2. 运行测试后，获取调试日志列表。sf apex list log --target-org myscratch APPLICATION DURATION (MS) ID LOCATION SIZE (B) LOG USER OPERATION REQUEST START TIME STATUS ─────────── ───────────── ─────── ───────── ──────── ───────── ─────────────── ─────── ─────────── ─────── Unknown 1143 07L9Axx SystemLog 23900 User User ApexTestHandler Api 2017-09-05x Success
3. 通过将调试日志的 ID 传递给 apex get log 命令来查看调试日志。

sf apex get log –log-id 07L9A000000aBYGUA2

38.0 APEX_CODE,FINEST;APEX_PROFILING,INFO;CALLOUT,INFO;DB,INFO;SYSTEM,DEBUG;VALIDATION,INFO;VISUALFORCE,INFO;WAVE,INFO;WORKFLOW,INFO
15:58:57.3 (3717091)|USER_INFO|[EXTERNAL]|0059A000000TwPM|test-ktjauhgzinnp@example.com|Pacific Standard Time|GMT-07:00
15:58:57.3 (3888677)|EXECUTION_STARTED
15:58:57.3 (3924515)|CODE_UNIT_STARTED|[EXTERNAL]|01p9A000000FmMN|RejectDuplicateFavoriteTest.acceptNonDuplicate()
15:58:57.3 (5372873)|HEAP_ALLOCATE|[72]|Bytes:3
…

沙盒是 Salesforce 组织的副本，可用于开发、测试、 和培训，而不会影响生产组织中的数据和应用程序。

Salesforce 提供沙盒和一组部署工具，因此您可以：

• 将自定义和开发工作与生产环境隔离开来，直到 你已准备好部署更改。
• 针对生产数据和用户的副本测试更改。
• 提供培训环境。
• 将单个更改协调到一个部署到生产中。

传统上，您或您的管理员通过 设置 UI。但是我们意识到，许多开发人员希望能够创建和管理他们的 以编程方式开发和测试环境，并自动执行其 CI 流程。 借助 Salesforce CLI，您可以同时做到这两点。

沙盒在应用程序开发生命周期中处于什么位置？

您使用的开发模型决定了您在哪些阶段使用沙盒。查看更多 有关我们的开发模型以及沙盒适合的位置的信息，请参阅确定适合的应用程序生命周期模型 你（Trailhead）。

• 授权生产组织
  JWT 和基于 Web 的流需要具有沙盒许可证的生产组织，而不是开发人员中心。但是，如果你的生产组织也是开发人员中心组织，则没关系。
• 创建沙盒定义文件
  在使用 Salesforce CLI 创建沙盒之前，请在沙盒定义文件中定义沙盒的配置。沙盒定义文件是沙盒的蓝图。您可以为在开发过程中使用的每种沙盒类型创建不同的定义文件。
• 创建、克隆或删除沙盒 创建用于开发、测试或训练的沙盒
  。克隆沙盒以将其数据和元数据复制到另一个沙盒。

授权您的生产组织

JWT 和基于 Web 的流程需要具有沙盒许可证的生产组织，而不是开发人员 枢纽。但是，如果你的生产组织也是开发人员中心组织，则没关系。

使用基于 JWT 的流程授权组织和使用基于 Web 的流程授权组织中的示例是针对的 走向 Scratch 组织。请按照以下提示成功授权您的生产组织。

• 请务必在 sfdx-project.json 文件中使用 for。 或者，您可以使用直接在命令行上指定 URL。此值将覆盖您的登录 URL 在 sfdx-project.json 文件中指定。https://login.salesforce.comsfdcLoginUrlorg login jwt –instance-url
• 运行命令时指定生产组织的用户名。无需指定 Dev Hub 或 指示默认的 Dev Hub。org login jwt
• JWT 授权流程要求您创建连接的应用程序。当你 创建连接的应用，登录到生产组织，而不是开发人员中心组织。

创建沙盒定义文件

在使用 Salesforce CLI 创建沙盒之前，请在 沙盒定义文件。沙盒定义文件是沙盒的蓝图。您可以 为开发中使用的每种沙盒类型创建不同的定义文件 过程。

沙盒配置值

注意

您可以在定义文件中指定其中之一，但不能同时指定两者。licenseTypesourceSandboxName

示例沙盒定义文件

尽管您可以将沙盒定义文件放在任何位置，但我们建议将其保留在 配置目录中的 Salesforce DX 项目。命名 文件中，我们建议提供以 sandbox-def.json 结尾的描述性名称，例如 developer-sandbox-def.json。

下面是用于创建沙盒的示例定义文件：

{
     "sandboxName": "dev1",
     "licenseType": "Developer"
}

下面是用于克隆沙盒的示例定义文件：

{
     "sandboxName": "dev1clone",
     "sourceSandboxName": "dev1"
}

创建、克隆或删除沙盒

创建用于开发、测试或训练的沙盒。克隆要复制的沙盒 其数据和元数据复制到另一个沙盒。

在创建或克隆沙盒之前：

• 使用清单文件创建 Salesforce DX 项目。
• 授权给具有可用沙盒许可证的生产组织。
• 创建沙箱定义文件。

为什么我们建议使用别名

创建或克隆沙盒时， 沙盒中生成的用户名基于生产组织中存在的用户名，或者 沙盒。用户名看起来像电子邮件地址，例如 .如果生成的用户名不是唯一的，我们会在前面添加一些 字符和数字添加到用户名中。修改后的用户名类似于 。username@company.com.dev100x7Vqusername@company.com.dev1

可以想象， 记住这些用户名可能具有挑战性，尤其是当您有多个沙盒时 管理。别名是管理和跟踪组织的有效方法，我们认为它是最好的 实践。因此，当您发出需要用户名的命令时，使用您可以 记住可以加快速度。如果您在创建沙盒时未设置别名，则 可以设置一个 后。

sf alias set MyDevSandbox username@company.com.dev1

创建沙盒

可选：创建沙箱定义文件

当您创建一个 沙盒，Salesforce 将元数据和可选数据从您的生产组织复制到 沙盒组织。使用该标志指定生产组织的用户名或别名。–target-org

sf org create sandbox --target-org prodOrg --definition-file config/dev-sandbox-def.json --alias MyDevSandbox --set-default --wait 30

这 命令要求您确认沙箱配置，然后将信息显示为沙箱 正在创建中。

旗帜 表示此沙盒是所有 CLI 命令的默认组织。如果您正在使用 多个组织，并且您不希望此组织成为默认值，请排除此标志。–set-default

直接 定义所需的沙盒选项，或覆盖沙盒定义中定义的值 文件，则在命令上指定适当的标志 线。

sf org create sandbox --name FullSbx --license-type=Full --target-org prodOrg --alias MyFullSandbox --wait 30

提示

由于沙盒是在队列中处理的，因此沙盒创建过程可能需要 比默认等待时间 6 分钟长。我们建议将较大的值设置为 ，例如 30 分钟。–wait

创作多长时间 流程需要取决于生产组织的规模和复杂性。您会看到状态消息 发布到 输出：

Sandbox Create... ⣾ 00:28:00 until timeout. 26%
 Field         Value                        
 ───────────── ──────────────────────────── 
 Id            0GR1Q888800HORuWAO           
 SandboxName   dev11                        
 Status        Processing                   
 LicenseType   DEVELOPER                    
 SandboxInfoId 0GQ1Q000009999mWAO           
 Created Date  2023-10-17T21:42:49.000+0000 
 CopyProgress  26%                          
 SandboxOrg    00DP0099993zEZj              
---------------------
Sandbox Create Stages
✓ - Pending
… - Processing
… - Activating
… - Authenticating

等待期结束后，您可以执行命令查看沙箱创建过程的状态。如果沙盒是 在等待时间内创建，Salesforce CLI 会自动在沙盒中进行身份验证。和 沙盒将显示在命令的输出中。 团队成员可以通过运行命令并提供其用户名和密码来向沙盒进行身份验证。org resume sandboxorg listorg web login

sf org web login --instance-url https://test.salesforce.com

克隆沙盒

您可以通过克隆现有沙盒来创建沙盒，而不是使用生产组织 作为您的来源。您可以通过使用一组数据和元数据自定义沙盒来节省时间，并且 然后复制它。使用 标志指定 现有沙箱名称和标志更改为 新的沙盒。这两个沙箱都必须与指定的生产组织相关联，该组织必须 包含沙盒许可证。（标志）。–clone–name–target-org

沙盒克隆简化了 应用程序生命周期。您可以为每种类型的工作设置沙盒，例如开发、 测试和暂存。您的同事可以轻松克隆单个沙盒，而不是共享 一个沙盒，踩着对方的脚趾。

sf org create sandbox --clone ExistingSandbox --name NewClonedSandbox --target-org prodOrg --alias MyDevSandbox --set-default --wait 30

提示

由于沙盒是在队列中处理的，因此沙盒克隆过程可以 花费的时间比默认的 6 分钟等待时间长。我们建议将较大的值设置为 ，例如 30 分钟。–wait

等待期结束后，您可以执行命令查看沙箱克隆过程的状态。如果沙盒是 在等待时间内克隆后，CLI 会自动在沙盒中进行身份验证。而 沙盒将显示在命令的输出中。团队 成员可以通过运行命令并提供其用户名和密码来对沙盒进行身份验证。org resume sandboxorg listorg web login

sf org web login --instance-url https://test.salesforce.com

检查沙盒状态

创建或克隆沙盒可能需要多次 纪要。如果命令超时，它会显示一个作业 ID，您可以将该 ID 传递给命令以报告创建或克隆 地位。当沙盒准备就绪时，此命令还会向 沙盒。org resume sandbox

sf org resume sandbox --job-id 0GR1888880000HORuWAO --target-org prodOrg

如果命令超时，则 未设置别名。但是，您可以使用以下命令进行设置：org create sandboxalias set

sf alias set MyDevSandbox username@company.com.dev1

打开沙盒

沙盒准备就绪后，您可以通过指定其用户名或别名来打开它。但是，您 不必提供其密码，因为 CLI 会管理 你。

sf org open --target-org MyDevSandbox

删除沙盒

您可以使用 Salesforce CLI 删除沙盒，无论 您在本地创建了它，或者记录了它 使用命令添加到现有沙箱中。您必须 之前还登录过包含沙盒许可证的生产组织。org create sandboxorg login

sf org delete sandbox --target-org MyDevSandbox

下一个：

• 将元数据从沙盒检索到本地 DX 项目。
• 直接在沙盒中进行开发，然后检索对本地 DX 的更改 项目。
• 将本地更改部署到沙盒。

跟踪项目和组织之间的更改

使用源跟踪来跟踪本地项目与临时组织之间的更改，或者 创建、更新或删除源代码时的沙盒。

源跟踪对组织没有直接影响;它仅影响您的本地环境。 具体而言，Salesforce CLI 会检查本地配置文件以确定您是否具有 为特定组织启用源跟踪。如果有，则源跟踪操作是 在处理组织时执行，例如使用命令。project deploy start

不带标志的命令 在本地项目和目标组织之间部署或检索所有更改的源。查看更多 精细控制，使用标志指定特定的元数据组件、包目录或 要部署或检索的清单文件。此示例检索 Apex 类：project deploy|retrieve startMyFabClass

sf project retrieve start --metadata ApexClass:MyFabClass

除了列出您所做的更改外，源跟踪还可以：

• 自动跟踪对元数据组件的更改，使您免于跟踪它们 手动地。
• 查看其他开发人员部署到沙盒的更改。
• 部署或检索更改的源。
• 识别并解决本地项目与临时组织或沙盒之间的冲突 在部署或检索源之前。

要查看哪些元数据组件支持源跟踪，请查看 元数据覆盖率报告。

• 管理组织的
  源跟踪 仅当目标组织允许时，源跟踪才有效。不用担心，您仍然可以在组织之间部署或检索元数据，而无需进行源跟踪。但是这些命令不会检查冲突，您必须使用适当的标志（如 或 ）准确指定要部署或检索的内容。–source-dir–metadata
• 预览源跟踪
  标识的更改 要查看本地项目与目标组织之间的更改，请导航到要查看其更改的项目目录。然后运行其中一个预览命令，该命令显示项目中可部署到组织的本地更改，或可检索的组织更改。
• 部署和检索源跟踪
  标识的更改 创建 Salesforce 应用程序时，通常同时使用低代码和专业代码技术。低代码的一个示例是使用 Setup 直接在组织中创建自定义对象。pro-code 的一个示例是使用 IDE（如 VS Code）在本地项目中创建 Apex 类。在您工作时，源跟踪会识别更改，以便您可以使组织中的远程元数据与本地项目中的源保持同步。
• 解决本地项目与组织
  之间的冲突 最佳做法是，如果本地项目或组织中的组件存在冲突，请在继续操作之前解决这些冲突。您可以手动解决冲突，也可以用组件的一个版本覆盖另一个版本。仅当您确定新版本是要使用的版本时，才覆盖更改。
• 通过查询 SourceMember 对象获取更改信息 若要了解有关开发人员组织中源跟踪更改的更多信息，请查询 SourceMember Tooling API 对象
  ，以了解进行了哪些更改以及谁进行了更改。Salesforce CLI 使用 SourceMember 对象来查看组织中的更改，作为其源跟踪功能的一部分。
• 最佳做法 遵循这些最佳做法
  ，充分利用源跟踪。
• 源跟踪的性能注意事项 源跟踪执行额外的功能来确定对源跟踪
  组件的更改，例如运行更多查询和等待 SourceMember 工具 API 对象在部署后更新。因此，在处理大中型项目时，某些命令可能需要更长的时间才能运行。如果您正在处理小型项目，您不会注意到任何速度变慢。

管理组织的源跟踪

源跟踪仅在目标组织允许的情况下才起作用。别担心，你仍然可以 在不进行源跟踪的情况下将元数据部署到组织或从组织检索元数据。但是命令 不要检查冲突，并且必须准确指定要部署或检索的内容 使用适当的标志，例如 或 .

–source-dir–metadata

支持源跟踪的组织版本

• Developer Edition 组织、生产组织、部分复制沙箱和完整 沙盒 – 不支持源跟踪。
• Developer 和 Developer Pro 沙盒 – 在以下情况下支持源跟踪 其关联的生产组织已启用源跟踪。
• 临时组织 – 始终支持来源追踪。

管理新组织中的源跟踪

Scratch Orgs 有源代码 默认情况下启用跟踪。对于 Developer 和 Developer Pro 沙盒，源 默认情况下，只要其关联的生产组织具有 已启用源跟踪。

在以下情况下，您可以选择退出来源跟踪 通过指定命令的标志来创建临时组织或沙箱。此标志仅影响您的本地 配置，而不是组织本身。Salesforce CLI 将本地配置选项设置为 向组织提供授权信息。如果您注销组织，然后重新登录 同样，默认情况下会再次启用源跟踪。–no-track-sourceorg create scratch|sandboxtrackSource: false

以下是创建 具有源代码跟踪功能的 Scratch 组织 禁用。

sf org create scratch --target-dev-hub=MyHub --definition-file config/project-scratch-def.json --no-track-source

这是 沙盒 例。

sf org create sandbox --definition-file config/dev-sandbox-def.json --target-org prodOrg --no-track-source

管理现有组织中的源跟踪

您可以使用以下方式更改现有临时组织或沙盒是否允许源跟踪 这两个命令：

• org enable tracking：允许 Salesforce CLI 以跟踪项目与组织之间源文件中的更改。
• org disable tracking：阻止 Salesforce CLI 从跟踪项目和 组织。

此示例说明如何在具有别名的组织中启用源跟踪;如果组织 不支持跟踪，例如完整沙盒。mySandbox

sf org enable tracking --target-org mySandbox

假设您有一个用于集成测试的沙盒，并且您希望 将源部署到它，但不要等待跟踪操作。此示例演示如何 在具有别名的组织上禁用源跟踪：mySandbox

sf org disable tracking --target-org mySandbox

预览源跟踪标识的更改

要查看本地项目与目标组织之间的更改，请导航到项目 要查看其更改的目录。然后运行其中一个预览命令，该命令显示 项目中可以部署到组织的本地更改，也可以是组织更改 可以检索。

1. 在终端或命令窗口中，导航到项目目录。在此示例中， 目录名为 MyProject。cd /Users/joe/dx-projects/MyProject
2. 若要查看项目和组织之间的更改，请运行项目部署预览版或项目 检索预览命令。包括 —target-org 标志以指定临时组织或沙箱的用户名或别名 要与本地项目进行比较。在此示例中，该命令显示 可以使用别名 DevSandbox 部署到沙盒的本地更改。sf project deploy preview --target-org DevSandbox同样，此示例显示沙盒中可检索的远程更改 返回到本地项目。sf project retrieve preview --target-org DevSandbox该命令接受 、 、 和标志，您可以使用它们来预览更多内容 精细部署。此示例仅预览元数据的部署：project deploy preview–metadata–source-dir–manifestApexClasssf project deploy preview --metadata ApexClass --target-org DevSandbox

此示例输出显示 对 Apex 类进行了局部更改，并且 WidgetObject__c可以部署到组织的自定义对象。project deploy previewWidgetClass

sf project deploy preview --target-org DevSandbox

No conflicts found.

No files will be deleted.

Will Deploy [2] files.
 Type         Fullname        Path                                                                           
 ──────────── ─────────────── ────────────────────────────────────────────────────────────────────────────── 
 ApexClass    WidgetClass     force-app/main/default/classes/WidgetClass.cls-meta.xml                        
 CustomObject WidgetObject__c force-app/main/default/objects/WidgetObject__c/WidgetObject__c.object-meta.xml 

No files were ignored. Update your .forceignore file if you want to ignore certain files.

此示例输出显示 对 Apex 类进行了远程更改，并且 GizmoObject__c可以从组织检索到本地的自定义对象（及其布局） 项目。输出还显示项目和组织之间没有冲突。project retrieve previewGizmoClass

sf project retrieve preview --target-org DevSandbox

No conflicts found.

No files will be deleted.

Will Retrieve [3] files.
 Type         Fullname                          Path 
 ──────────── ───────────────────────────────── ──── 
 Layout       GizmoObject__c-GizmoObject Layout      
 CustomObject GizmoObject__c                         
 ApexClass    GizmoClass                             

Ignored [2] files. These files won't retrieve because they're ignored by your .forceignore file.
 Type    Fullname                            Path 
 ─────── ─────────────────────────────────── ──── 
 Profile Admin                                    
 Profile B2B Reordering Portal Buyer Profile

预览命令使用包含三列的更改信息表：Type、Fullname 和 路径。每行代表一个更改。

• Type 是已更改组件的元数据类型。它描述了组件的内容 是，例如 Apex 类或自定义对象。
• Fullname 是组件的 API 名称。
• 路径是组件在本地项目中的位置。如果为空，则 组件在本地项目中不存在。当空白时，通常意味着组件是 存在于组织中，但不存在于本地项目中。

如果源跟踪未检测到任何更改，则预览命令将返回一条语句 谚语。No results found

=== Source Status
No results found

在本地项目和组织中预览源中的更改后，即可 部署或检索并解决潜在冲突。

部署和检索源跟踪标识的更改

创建 Salesforce 应用程序时，通常同时使用低代码和专业代码 技术。低代码的一个示例是使用 Setup 直接在组织中创建自定义对象。 pro-code 的一个示例是使用 IDE（如 VS）在本地项目中创建 Apex 类 法典。在您工作时，源跟踪会识别更改，以便您可以将远程元数据保留在 组织与本地项目中的源同步。

该过程是迭代的。首先，预览远程和本地更改。如果存在冲突， 你解决它们。现在，您必须确保这些更改同时存在于组织和本地 项目。因此，您可以检索到本地项目的远程更改，然后将它们推送到 源代码管理存储库，以确保源代码管理系统包含所有更改 并且是历史真相的源泉。将本地更改（如 Apex 代码）部署到 组织，以便您可以验证和测试它。你不断迭代这个过程，直到你 完成 Salesforce 应用程序的开发。

要了解源跟踪的实际效果，让我们看一些示例。

假设您运行并看到远程 变化。project retrieve preview

sf project retrieve preview --target-org DevSandbox

No conflicts found.

No files will be deleted.

Will Retrieve [3] files.
 Type         Fullname                          Path 
 ──────────── ───────────────────────────────── ──── 
 Layout       GizmoObject__c-GizmoObject Layout      
 CustomObject GizmoObject__c                         
 ApexClass    GizmoClass                             

Ignored [2] files. These files won't retrieve because they're ignored by your .forceignore file.
 Type    Fullname                            Path 
 ─────── ─────────────────────────────────── ──── 
 Profile Admin                                    
 Profile B2B Reordering Portal Buyer Profile

使用命令将组织中的更改检索到本地项目。现在组件已在本地创建， “路径”列具有一个值，它包含默认包目录。project retrieve start

sf project retrieve start --target-org DevSandbox
Preparing retrieve request... ⣟ Sending request to org
Preparing retrieve request... Succeeded

Retrieved Source
=========================================================================================================================================
| State   Name                              Type         Path                                                                             
| ─────── ───────────────────────────────── ──────────── ──────────────────────────────────────────────────────────────────────────────── 
| Created GizmoClass                        ApexClass    force-app/main/default/classes/GizmoClass.cls                                    
| Created GizmoClass                        ApexClass    force-app/main/default/classes/GizmoClass.cls-meta.xml                           
| Created GizmoObject__c                    CustomObject force-app/main/default/objects/GizmoObject__c/GizmoObject__c.object-meta.xml     
| Created GizmoObject__c-GizmoObject Layout Layout       force-app/main/default/layouts/GizmoObject__c-GizmoObject Layout.layout-meta.xml

检索源后，再次运行。现在，源跟踪报告没有可检索的内容。project retrieve preview

sf project retrieve preview 

No conflicts found.

No files will be deleted.

No files will be retrieved.

Ignored [2] files. These files won't retrieve because they're ignored by your .forceignore file.
 Type    Fullname                            Path 
 ─────── ─────────────────────────────────── ──── 
 Profile Admin                                    
 Profile B2B Reordering Portal Buyer Profile

现在让我们看一下部署。要预览本地更改，请运行 。project deploy preview

sf project deploy preview --target-org DevSandbox

No conflicts found.

No files will be deleted.

Will Deploy [2] files.
 Type         Fullname        Path                                                                           
 ──────────── ─────────────── ────────────────────────────────────────────────────────────────────────────── 
 ApexClass    WidgetClass     force-app/main/default/classes/WidgetClass.cls-meta.xml                        
 CustomObject WidgetObject__c force-app/main/default/objects/WidgetObject__c/WidgetObject__c.object-meta.xml 

No files were ignored. Update your .forceignore file if you want to ignore certain files.

然后部署本地更改。部署到沙盒后，其他使用 沙盒可以看到您的更改。

sf project deploy start --target-org DevSandbox
Deploying v59.0 metadata to test-ikspctiorkzs@example.com using the v59.0 SOAP API.
Deploy ID: 0Af8D00000pNmKySAK
Status: Succeeded | ████████████████████████████████████████ | 2/2 Components (Errors:0) | 0/0 Tests (Errors:0)

Deployed Source
=====================================================================================================================
| State   Name            Type         Path                                                                           
| ─────── ─────────────── ──────────── ────────────────────────────────────────────────────────────────────────────── 
| Created WidgetClass     ApexClass    force-app/main/default/classes/WidgetClass.cls                                 
| Created WidgetClass     ApexClass    force-app/main/default/classes/WidgetClass.cls-meta.xml                        
| Created WidgetObject__c CustomObject force-app/main/default/objects/WidgetObject__c/WidgetObject__c.object-meta.xml

再次运行。project deploy preview

sf project deploy preview

No conflicts found.

No files will be deleted.

No files will be deployed.

No files were ignored. Update your .forceignore file if you want to ignore certain files.

该命令报告没有要部署的内容，指示您的本地项目和组织 是同步的。

• 使用源跟踪检索对配置文件的更改 检索配置文件的行为与源跟踪
  略有不同。

使用源跟踪检索对配置文件的更改

检索配置文件的行为与源跟踪略有不同。

重要

通常，我们建议您使用权限集而不是 配置 文件。配置文件在组织之间不一致，检索到的源文件和 部署取决于组织类型、跟踪状态和操作中的其他元数据。如果 您决定继续使用配置文件，我们建议您在部署或 通过将它们添加到文件中进行检索。.forceignore

如果没有源跟踪，检索配置文件只会返回一些配置文件信息。 检索配置文件将返回与指定其他项目相关的配置文件的相关信息 在文件中。package.xml

例如，使用此文件检索配置文件将返回帐户上MyCustomField__c自定义字段的配置文件权限 对象。package.xml

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
 <types>
  <members>Account.MyCustomField__c</members>
  <name>CustomField</name>
 </types>
 <types>
  <members>*</members>
  <name>Profile</name>
 </types>
 <version>50.0</version>
</Package>

通过源跟踪，检索配置文件会返回与任何内容相关的配置文件信息 文件中指定的 else 加上 any 通过源跟踪跟踪组件。这包括更改的任何实体 存在于本地项目和组织之间。package.xml

例如，假设您在 Opportunity 对象上创建了一个名为 OppCustomField__c 的自定义字段 在本地环境中。源跟踪检测到更改并报告它。现在您检索 配置文件使用与以下情况相同的文件 源跟踪已关闭。package.xml

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
 <types>
  <members>Account.MyCustomField__c</members>
  <name>CustomField</name>
 </types>
 <types>
  <members>*</members>
  <name>Profile</name>
 </types>
 <version>50.0</version>
</Package>

即使文件没有引用 OppCustomField__c，由于源跟踪正在跟踪新的自定义字段，因此您的检索 返回 Account 对象上MyCustomField__c自定义字段的配置文件权限 以及 Opportunity 对象上的OppCustomField__c。package.xml

有关检索配置文件的详细信息，请参阅元数据 API 中的配置文件元数据类型 开发人员指南。

注意

尽管源检索不包括文件，但检索请求会返回与 源跟踪。package.xml

解决本地项目与组织之间的冲突

最佳做法是，如果本地项目或 组织，在继续前进之前解决它们。您可以手动解决冲突，也可以覆盖冲突 一个组件的版本与另一个组件。仅当您确定新的 version 是您要使用的版本。

假设你跑步并看到冲突 本地项目与组织中的更改。例如，此命令输出显示具有冲突的更改，但已准备好部署。project deploy previewWidgetClassGizmoClass

sf project deploy preview --target-org DevSandbox

Conflicts [1]. Run the command with the --ignore-conflicts flag to override.
 Type      Fullname    Path                                                    
 ───────── ─────────── ─────────────────────────────────────────────────────── 
 ApexClass WidgetClass force-app/main/default/classes/WidgetClass.cls-meta.xml 

No files will be deleted.

Will Deploy [1] files.
 Type      Fullname   Path                                                   
 ───────── ────────── ────────────────────────────────────────────────────── 
 ApexClass GizmoClass force-app/main/default/classes/GizmoClass.cls-meta.xml 

No files were ignored. Update your .forceignore file if you want to ignore certain files.

如果您尝试实际部署源，Salesforce CLI 会再次报告冲突并停止 完成时的操作。运行 时会看到类似的冲突消息。若要成功部署或检索，请执行以下操作： 首先解决冲突，然后用 已解析的文件。让我们看看这是如何工作的。project retrieve preview

覆盖冲突的更改

如果您确定本地版本是正确的，请覆盖 组织，在以下情况下包含标志 部署。在我们的例子中，因为只有 冲突的更改，让我们首先部署该组件以消除冲突和 然后稍后部署无冲突的源。–ignore-conflictsWidgetClass

sf project deploy start --metadata ApexClass:WidgetClass --ignore-conflicts --target-org DevSandbox

DevSandbox 组织现在具有与本地项目中相同的版本。再次运行时，看不到任何冲突的更改 消息。WidgetClassproject deploy preview

但是，如果您确定组织中的版本是正确的，则通过以下方式覆盖本地副本 检索 DevSandbox 组织版本，同时忽略冲突。WidgetClass

sf project retrieve start --metadata ApexClass:WidgetClass --ignore-conflicts --target-org DevSandbox

您的本地项目现在具有与组织中相同的版本。WidgetClass

干得好，你解决了冲突！现在，无需任何特殊标志即可运行，以完成部署和任何其他新的本地源。project deploy startGizmoClass

sf project deploy start --target-org DevSandbox
Deploying v59.0 metadata to test-ikspctiorkzs@example.com using the v59.0 SOAP API.
Deploy ID: 0Af8D00000pNtEUSA0
Status: Succeeded | ████████████████████████████████████████ | 1/1 Components (Errors:0) | 0/0 Tests (Errors:0)

Deployed Source
=====================================================================================
| State   Name       Type      Path                                                   
| ─────── ────────── ───────── ────────────────────────────────────────────────────── 
| Created GizmoClass ApexClass force-app/main/default/classes/GizmoClass.cls          
| Created GizmoClass ApexClass force-app/main/default/classes/GizmoClass.cls-meta.xml

通过查询 SourceMember 对象获取更改信息

若要详细了解开发人员组织中的源跟踪更改，请查询 SourceMember 工具 API 对象，用于找出进行了哪些更改以及谁进行了更改。Salesforce CLI 使用 SourceMember 对象，以查看组织中作为其源跟踪的一部分所做的更改 功能性。

例如，通过运行类似 这。在此示例中，DevSandbox 是沙盒的用户名或别名。

sf data query --query "SELECT MemberName, MemberType, ChangedBy, RevisionCounter FROM SourceMember" --use-tooling-api --target-org DevSandbox

该查询返回元数据组件的列表。CHANGEDBY 列返回 上次更改组件的人员。REVISIONCOUNTER 列返回组件的 修订号。Salesforce 使用修订计数器来确定哪些实体在 组织。

MEMBERNAME                   MEMBERTYPE    CHANGEDBY        REVISIONCOUNTER
───────────────────────────  ────────────  ───────────────  ───────────────
Account.MyTextField__c       CustomField   0056g000000FDuZ  1
Contact.MyField__c           CustomField   0056g000000FDuZ  11
Admin                        Profile       0051k000002KW4R  54
MyObj1__c-MyObj1 Layout      Layout        0051k000002KW4R  55
Account-Account Layout       Layout        0056g000000FDuZ  33
Contact-Contact Layout       Layout        0056g000000FDuZ  45
MyObj1__c                    CustomObject  0051k000002KW4R  57
TVRemoteControl              ApexClass     0056g000000FDuZ  53

您可以使用此输出来运行其他有用的查询。例如，要获取 上次更改 Apex 类的人，运行 此查询将 ID 从 CHANGEDBY 映射到用户名：TVRemoteControl

sf data query --query "SELECT Id,Username,Name FROM User WHERE Id = '0056g000000FDuZ'" --target-org DevSandbox

结果类似于：

ID                  USERNAME                   NAME
──────────────────  ────────────────────────   ────────────
0056g000000FDuZQAS  dev2@example.com.devsb1    Dev2

可以使用 SourceMember 对象来解决问题。例如，假设您更改 组织中的元数据，但更改未显示在 OR 中。检查 SourceMember 的字段是否记录了该字段 元数据组件正在正确递增。project retrieve previewproject retrieve startRevisionCounter

另一个用例是将源跟踪重置回特定的修订号。

sf project reset tracking --revision 30 --target-org DevSandbox

警告

命令 删除或覆盖所有现有的源跟踪文件。使用时要格外小心。project reset tracking

最佳实践

遵循这些最佳实践，充分利用源跟踪。

在将更改部署到 沙盒

这种做法可帮助其他开发人员合并您的更改并促进 协作。

使用 Git 等版本控制系统查看元数据更改历史记录

使用版本控制系统，您可以对更改进行版本控制、跟踪更改历史记录以及 在升级到其他环境（如沙盒）之前查看元数据更改。

让源跟踪文件恢复同步

如果源跟踪感到困惑并开始报告不准确，您可以使用这些命令恢复同步。 使用哪个命令取决于您最信任的源：如果您信任本地源文件，并且信任 组织。对于任一命令，请指定标志。有关详细信息和示例，请参阅解决本地项目与组织之间的冲突。project deploy|retrieve startproject deploy startproject retrieve start–ignore-conflicts

源跟踪的性能注意事项

源跟踪执行额外的功能来确定对跟踪源的更改 组件，例如运行更多查询并等待 SourceMember Tooling API 对象 部署后更新。因此，某些命令在使用 大中型项目。如果你正在处理小项目，你不会注意到任何 减速。

中型项目具有 30 个或更多组件或 50 个或更多测试。一个有 25 个的项目 组件和 51 项测试被认为是中等的。

大型项目需要 600 个或更多组件或 150 个或更多测试。一个有 610 的项目 组件和 140 次测试被认为是大型的。

如果遇到长时间运行的命令，请将项目分解为较小的命令集 组件，并部署较小的集合。

您还可以在创建临时组织或沙盒时选择退出源跟踪，方法是指定 命令的标志。有关用例，请参阅源跟踪。–no-track-sourceorg create scratch|sandbox

如果在 DevOps Center 中创建临时组织或沙盒以用作开发环境， 不要禁用源跟踪。