使用 .forceignore 檔案排除中繼資料
使用 .forceignore 檔案可排除您不想認可至來源控制或部署至發行管道中目標組織的檔案或中繼資料類型。此檔案可確保 DX Inspector 和 DevOps Center 不會從開發環境推送或提取不必要的檔案,例如 IDE 組態檔、本機測試資料或特定設定檔。
必要版本
| 提供版本:Professional (需要 API 存取權)、Enterprise、Performance、Unlimited 及 Developer Edition 的 Lightning Experience |
| 提供版本:Government Cloud Plus 可交互操作。在 Government Cloud Plus 組織中開啟 DevOps Center,可將資料傳送到授權邊界之外。請連絡您的 Salesforce 帳戶主管以取得詳細資訊。 |
| 不適用於:歐盟運作區域。歐盟運作區域是特殊付費的供應項目,提供增強層級的資料落地承諾。歐盟中的組織支援 DevOps Center,因為依照產品條款與條件,這些組織不屬於 EU OZ。 |
在認可流程期間,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 檔案。
另請參照:
此文章是否解決您的問題?
請讓我們知道,以便我們改進!

