使用 .forceignore 文件排除元数据
使用 .forceignore 文件排除您不想提交到源控件或部署到发布漏斗中的目标组织的文件或元数据类型。该文件确保 DX 检查器和 DevOps Center 不会从开发环境推送或提取不必要的文件,例如 IDE 配置文件、本地测试数据或特定简档。
所需的 Edition
| 适用于:Lightning Experience in Professional(需要 API 访问权限)、Enterprise、Performance、Unlimited 和 Developer Edition |
| 适用于:Government Cloud Plus 作为可互操作。在 Government Cloud Plus 组织中打开 DevOps Center 可以将数据发送到授权边界之外。联系您的 Salesforce 客户主管了解更多详细信息。 |
| 不适用于:欧盟操作区域。欧盟操作区域是一项特殊的付费服务,提供了更高级别的数据驻留承诺。根据标准产品条款和条件,DevOps Center 在不属于欧盟操作区域的欧盟组织中获得支持。 |
在提交过程中,DX 检查器读取 .forceignore 文件,并从源控制存储库和工作项目中排除匹配文件和元数据。DevOps Center 会在升级期间读取文件,以识别和排除元数据类型和文件,从而阻止部署它们。
创建 .forceignore 文件时的注意事项
- 如果您使用模板创建存储库,请根据您的项目要求更新 .forceignore 文件。
- 如果要将 .forceignore 文件添加到现有存储库,请将该文件放在 Salesforce DX 项目目录的根文件夹中。
- 虽然您可以随时创建 .forceignore 文件,但我们建议在构建漏斗时创建它,以便从一开始就正确使用。
- 在激活漏斗之前,在与发布环境相关联的主分支中配置文件。此步骤将文件复制到新分支。
- 构建漏斗时,如果 DevOps Center 创建存储库和分支,每个阶段分支都会从主分支继承 .forceignore 文件。如果您连接现有存储库或重复使用现有分支,请手动添加 .forceignore 文件(如果不可用)。
- 工作项目功能分支使用第一个漏斗阶段分支中的文件版本。
- 激活漏斗后,DevOps Center 会在提取或升级更改时应用文件规则。
示例 .forceignore 语法
.forceignore 文件结构与 .gitignore 结构相似。文件中的每一行都包含与要排除的文件相对应的模式,例如 LWC 配置文件、JSON 文件或测试。
此示例文件包含开发人员希望在提交或升级时排除的常见文件和文件夹。升级(部署)和拉取(检索)操作的语法不同。例如,要在升级更改时排除所有简档,请使用 **/profiles/**。要在提取更改时排除所有简档,请使用 *.profile。请参阅如何在同步时排除源。
# List files or folders below to ignore them when deploying and retrieving changes
# Standard metadata
package.xml
# These metadata files are ignored when promoting (deploying)
**/appMenus/**
**/appSwitcher/**
**/fieldRestrictionRules/**
**/objectTranslations/**
**/profiles/**
**/profilePasswordPolicy/**
**/profileSessionSetting/**
**/settings/**
**/sharingRules/**
**/AuthProvider/**
# These metadata files are ignored when pulling (retrieving)
*.settings
*.appMenu
*.appSwitcher
*.rule
*.objectTranslation
*.profile
*.profilePasswordPolicy
*.profileSessionSetting
*.sharingRules
*.AuthProvider
# LWC configuration files
**/jsconfig.json
**/.eslintrc.json
# LWC Jest
**/__tests__/**更新 .forceignore 文件时的注意事项
- 更新漏斗存储库主分支中的 .forceignore 文件。
- 如果您有多个 DevOps Center 漏斗,请更新每个漏斗存储库中的文件。
- 如果漏斗已在使用,更改不会自动应用到现有分支。要在任何地方应用它们,请在工作项目中进行更改并升级该工作项目。这样,DevOps Center 会在您升级时将更新的 .forceignore 文件应用于漏斗分支。
另请参阅:
本文章是否解决您的问题?
请与我们共享您的想法,以便我们进行改进!

