Informations de référence sur le format de contrôle de code source YAML de la solution

Cet article est une référence pour le format de contrôle de code source basé sur YAML utilisé lorsque vous procédez comme suit :

• Valider des solutions à l’aide de l’intégration git native Dataverse Git dans Power Apps.
• Extraire des solutions à l’aide pac solution clone ou pac solution sync.
• Exécutez manuellement SolutionPackager sur un dossier qui contient des fichiers manifeste YAML.

Le format YAML diffère de la disposition XML classique. Comprendre la structure est importante lorsque vous souhaitez empaqueter manuellement un dossier YAML dans un .zip fichier que Dataverse peut importer.

Vue d’ensemble de la structure des dossiers

Une racine de référentiel au format YAML contient les répertoires de niveau supérieur suivants :

<repositoryRoot>/
├── solutions/
│   └── <SolutionUniqueName>/       (one subfolder per solution)
│       ├── solution.yml
│       ├── solutioncomponents.yml
│       ├── rootcomponents.yml
│       └── missingdependencies.yml
├── publishers/
│   └── <PublisherUniqueName>/      (one subfolder per publisher)
│       └── publisher.yml
├── entities/                        (entity components, if any)
│   └── <entity_schema_name>/
│       ├── attributes/
│       ├── formxml/
│       ├── savedqueries/
│       └── ...
├── workflows/                       (classic workflow definitions, if any)
├── modernflows/                     (Power Automate cloud flows, if any)
├── canvasapps/                      (canvas app .msapp files, if any)
│   └── <canvas_app_schema_name>/
│       └── <name>.msapp
├── environmentvariabledefinitions/  (environment variable definitions, if any)
├── connectors/                      (custom connectors, if any)
└── [other component folders]/

Les solutions/ répertoires et publishers/ les répertoires sont requis. Tous les dossiers de composants à la racine sont facultatifs et dépendent de ce que contient la solution.

Mise en forme de la détection automatique

SolutionPackager (et pac solution pack) détectez automatiquement le format comme suit :

Fichiers manifestes

solution.yml

Situé à solutions/<SolutionUniqueName>/solution.yml. Contient des métadonnées de solution de niveau supérieur : l’équivalent YAML du solution.xml format XML.

Les champs clés incluent le nom unique, la version, le nom convivial, la description et une référence au serveur de publication.

solutioncomponents.yml

Situé à solutions/<SolutionUniqueName>/solutioncomponents.yml. Répertorie les chemins d’accès relatifs à tous les fichiers de composant inclus dans cette solution. SolutionPackager lit ce fichier pendant le pack pour localiser les sources de composants.

Exemple d’extrait :

- Path: entities/account
- Path: entities/contact
- Path: canvasapps/myapp_<guid>
- Path: publishers/MyPublisher

rootcomponents.yml

Situé à solutions/<SolutionUniqueName>/rootcomponents.yml. Répertorie les composants de niveau racine (généralement des tables et d’autres objets de niveau supérieur) qui appartiennent à cette solution.

missingdependencies.yml

Situé à solutions/<SolutionUniqueName>/missingdependencies.yml. Enregistre les dépendances de solution qui n’étaient pas présentes lors de la dernière exportation de la solution. Utilisé à des fins d’information et pour valider l’exhaustivité lors de l’importation.

publisher.yml

Situé à publishers/<PublisherUniqueName>/publisher.yml. Contient la définition de l’éditeur : nom unique, nom complet, préfixe de personnalisation et préfixe de valeur d’option.

Structure minimale requise :

Publisher:
  UniqueName: mypublisher
  LocalizedNames:
    LocalizedName:
      '@description': My Publisher
      '@languagecode': '1033'
  Descriptions:
  EMailAddress:
    '@xsi:nil': 'true'
    '@xmlns:xsi': http://www.w3.org/2001/XMLSchema-instance
  SupportingWebsiteUrl:
    '@xsi:nil': 'true'
    '@xmlns:xsi': http://www.w3.org/2001/XMLSchema-instance
  CustomizationPrefix: myp
  CustomizationOptionValuePrefix: '12345'
  Addresses:

Prise en charge du type de composant

Le tableau suivant répertorie la façon dont chaque type de composant est géré au format YAML.

Référentiels multi-solutions

Une racine de référentiel unique peut contenir plusieurs solutions. Toutes les solutions partagent les mêmes dossiers de composants ; solutioncomponents.yml dans chaque solution contrôle quels chemins de composant appartiennent à cette solution.

Exemple de structure avec deux solutions :

<repositoryRoot>/
├── solutions/
│   ├── SolutionA/
│   │   ├── solution.yml
│   │   ├── solutioncomponents.yml    ← references entities/account, entities/contact
│   │   ├── rootcomponents.yml
│   │   └── missingdependencies.yml
│   └── SolutionB/
│       ├── solution.yml
│       ├── solutioncomponents.yml    ← references entities/lead, workflows/myflow
│       ├── rootcomponents.yml
│       └── missingdependencies.yml
├── publishers/
│   └── SharedPublisher/
│       └── publisher.yml
├── entities/
│   ├── account/
│   ├── contact/
│   └── lead/
└── workflows/
    └── myflow/

Empaquetage d’une solution spécifique à partir d’un dossier multi-solution

Utilisation de SolutionPackager.exe:

SolutionPackager.exe /action:Pack /zipfile:SolutionA.zip /folder:C:\repos\myrepo /SolutionName:SolutionA

Utilisation pac solution pack (dossiers à solution unique uniquement - pour plusieurs solutions, utilisez SolutionPackager.exe directement avec /SolutionName) :

pac solution pack --zipfile SolutionA.zip --folder C:\repos\myrepo

Utilisation des dossiers de format YAML

Empaquetez un dossier YAML dans un fichier .zip

# Using pac CLI (single solution in folder)
pac solution pack --zipfile C:\output\MySolution.zip --folder C:\repos\myrepo

# Using SolutionPackager.exe directly (also works for multi-solution with /SolutionName)
SolutionPackager.exe /action:Pack /zipfile:C:\output\MySolution.zip /folder:C:\repos\myrepo

Obtenir un dossier YAML complet à partir de Dataverse

La méthode recommandée pour obtenir un dossier YAML complet et packable consiste à utiliser pac solution clone:

pac solution clone --name MySolutionUniqueName --outputDirectory C:\repos\myrepo

Cela extrait la solution au format YAML, y compris tous les fichiers sources du composant. Vous pouvez également utiliser l’intégration Git native pour valider à partir de Power Apps : les fichiers validés sont au format YAML et entièrement packables.

Vérifier le dossier avant l’empaquetage

Vérifiez que le solutions/<name>/ dossier existe et que tous les chemins d’accès résolus solutioncomponents.yml en fichiers réels sont résolus. Les chemins manquants entraînent des avertissements pendant le pack et ces composants sont omis.

Relation avec l’intégration de Dataverse Git

Le format de contrôle de code source YAML est le format canonique utilisé par l’intégration de Dataverse Git. Lorsque les créateurs valident des solutions à partir de Power Apps, les fichiers écrits dans Azure DevOps utilisent ce format. Les développeurs code-first peuvent utiliser le même référentiel à l’aide des outils CLI décrits ici.

Pour plus d’informations sur la connexion d’environnements à Git, consultez la configuration de l’intégration De Dataverse Git.

Contenu connexe

• Outil SolutionPackager
• Contrôle de code source avec des fichiers de solution
• Pack de solutions PAC
• Déballage de la solution pac
• Vue d’ensemble de l’intégration De Dataverse Git