Exclusion des métadonnées avec le fichier .forceignore

Considérations relatives à la création du fichier .forceignore

• Si vous avez utilisé notre modèle pour créer le référentiel, mettez à jour le fichier .forceignore en fonction des exigences de votre projet.
• Si vous ajoutez le fichier .forceignore à un référentiel existant, placez-le dans le dossier racine du répertoire de votre projet Salesforce DX.
• Vous pouvez créer le .forceignorefile à tout moment, mais nous recommandons de le créer lorsque vous élaborez votre pipeline afin qu'il soit en place dès le départ.
• Configurez le fichier dans la branche principale associée à votre environnement de publication avant d'activer votre pipeline. Cette étape copie les fichiers dans de nouvelles agences.
• Lorsque vous élaborez votre pipeline, si DevOps Center crée le référentiel et les branches, chaque branche d'étape hérite du fichier .forceignore de la branche principale. Si vous connectez un référentiel existant ou réutilisez des branches existantes, ajoutez manuellement un fichier .forceignore s'il n'est pas disponible.
• Les branches de fonctionnalité d'élément de travail utilisent la version du fichier de la première branche de l'étape du pipeline.
• Après avoir activé le pipeline, DevOps Center applique les règles de fichier lors de l'extraction ou de la promotion de modifications.

Exemple de syntaxe .forceignore

La structure du fichier .forceignore est similaire à la structure .gitignore. Chaque ligne du fichier contient un modèle correspondant aux fichiers que vous souhaitez exclure, par exemple des fichiers de configuration LWC, des fichiers JSON ou des tests.

Cet exemple de fichier contient des fichiers et des dossiers courants que les développeurs souhaitent exclure lors d'un engagement ou d'une promotion. La syntaxe est différente pour les opérations promouvoir (déployer) et extraire (récupérer). Par exemple, pour exclure tous les profils lors de la promotion de modifications, utilisez **/profiles/**. Pour exclure tous les profils lors de l'extraction des modifications, utilisez *.profile. Consultez Comment exclure la source lors de la synchronisation.

# 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__/**

Considérations relatives à la mise à jour du fichier .forceignore

• Mettez à jour le fichier .forceignore dans la branche principale de votre référentiel pipeline.
• Si vous avez plusieurs pipelines DevOps Center, mettez à jour le fichier dans chaque référentiel de pipeline.
• Si le pipeline est déjà utilisé, les modifications ne s'appliquent pas automatiquement aux agences existantes. Pour les appliquer partout, effectuez la modification dans un élément de travail et faites la promotion de cet élément. De cette façon, DevOps Center applique le fichier .forceignore mis à jour à travers les branches du pipeline pendant votre promotion.