.forceignore ファイルを使用したメタデータの除外

.forceignore ファイルを作成するときの考慮事項

• テンプレートを使用してリポジトリを作成した場合は、プロジェクト要件に合わせて .forceignore ファイルを更新します。
• 既存のリポジトリに.forceignoreファイルを追加する場合は、Salesforce DXプロジェクトディレクトリのルートフォルダにファイルを置きます。
• .forceignore ファイルはいつでも作成できますが、パイプラインの構築時に作成して最初から所定の位置にしておくことをお勧めします。
• パイプラインを有効化する前に、リリース環境に関連付けられたメインブランチでファイルを設定します。このステップでは、ファイルを新しいブランチにコピーします。
• パイプラインを構築するときに、DevOps センターでリポジトリとブランチが作成されると、各フェーズブランチはメインブランチから .forceignore ファイルを継承します。既存のリポジトリを接続するか、既存の分岐を再利用する場合は、.forceignore ファイルが使用できない場合、手動で追加します。
• 作業項目機能ブランチでは、最初のパイプラインフェーズブランチのファイルバージョンが使用されます。
• パイプラインを有効化すると、DevOps センター は変更の取り込みまたは昇格時にファイルルールを適用します。

サンプル .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センター パイプラインがある場合は、各パイプライン リポジトリでファイルを更新します。
• パイプラインがすでに使用されている場合、変更は既存のブランチに自動的に適用されません。すべての場所に適用するには、作業項目を変更して、その作業項目を昇格させます。これにより、昇格時に、DevOps Centerによって更新された.forceignoreファイルがパイプライン ブランチ全体に適用されます。