Referencia de formato de control de código fuente de YAML de solución

Este artículo es una referencia para el formato de control de código fuente basado en YAML que se usa al:

• Confirme soluciones mediante la integración nativa de Git de Dataverse en Power Apps.
• Extraiga soluciones mediante pac solution clone o pac solution sync.
• Ejecute manualmente SolutionPackager en una carpeta que contenga archivos de manifiesto DE YAML.

El formato YAML difiere del diseño XML clásico. Comprender la estructura es importante cuando desea empaquetar manualmente una carpeta YAML en un .zip archivo que Dataverse puede importar.

Introducción a la estructura de carpetas

Una raíz del repositorio de formato YAML contiene los siguientes directorios de nivel superior:

<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]/

Los solutions/ directorios y publishers/ son necesarios. Todas las carpetas de componentes de la raíz son opcionales y dependen de lo que contiene la solución.

Dar formato a la detección automática

SolutionPackager (y pac solution pack) detectan automáticamente el formato de la siguiente manera:

Archivos de manifiesto

solution.yml

Ubicado en solutions/<SolutionUniqueName>/solution.yml. Contiene metadatos de solución de nivel superior: el equivalente de YAML en solution.xml formato XML.

Entre los campos clave se incluyen el nombre único de la solución, la versión, el nombre descriptivo, la descripción y una referencia al publicador.

solutioncomponents.yml

Ubicado en solutions/<SolutionUniqueName>/solutioncomponents.yml. Enumera las rutas de acceso relativas a todos los archivos de componentes incluidos en esta solución. SolutionPackager lee este archivo durante el paquete para buscar orígenes de componentes.

Extracto de ejemplo:

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

rootcomponents.yml

Ubicado en solutions/<SolutionUniqueName>/rootcomponents.yml. Enumera los componentes de nivel raíz (normalmente tablas y otros objetos de nivel superior) que pertenecen a esta solución.

missingdependencies.yml

Ubicado en solutions/<SolutionUniqueName>/missingdependencies.yml. Registra las dependencias de solución que no estaban presentes cuando la solución se exportó por última vez. Se usa con fines informativos y para validar la integridad de la importación.

publisher.yml

Ubicado en publishers/<PublisherUniqueName>/publisher.yml. Contiene la definición del publicador: nombre único, nombre para mostrar, prefijo de personalización y prefijo de valor de opción.

Estructura mínima necesaria:

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:

Compatibilidad con tipos de componentes

En la tabla siguiente se muestra cómo se controla cada tipo de componente en el formato YAML.

Repositorios de varias soluciones

Una única raíz del repositorio puede contener varias soluciones. Todas las soluciones comparten las mismas carpetas de componentes; solutioncomponents.yml en cada solución controla qué rutas de acceso de componente pertenecen a esa solución.

Estructura de ejemplo con dos soluciones:

<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/

Empaquetado de una solución específica desde una carpeta de varias soluciones

Uso de SolutionPackager.exe:

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

Uso pac solution pack de (solo carpetas de una sola solución, para varias soluciones, use SolutionPackager.exe directamente con /SolutionName):

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

Trabajar con carpetas de formato YAML

Empaquetar una carpeta YAML en un archivo .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

Obtención de una carpeta YAML completa de Dataverse

La manera recomendada de obtener una carpeta YAML completa y empaquetable es usar pac solution clone:

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

Esto extrae la solución en el formato YAML, incluidos todos los archivos de origen de componentes. Como alternativa, use la integración nativa de Git para confirmar desde Power Apps: los archivos confirmados están en formato YAML y totalmente empaquetables.

Comprobación de la carpeta antes de empaquetar

Compruebe que la solutions/<name>/ carpeta existe y que todas las rutas de acceso de resolución se resuelven en solutioncomponents.yml archivos reales. Las rutas de acceso que faltan producen advertencias durante el paquete y esos componentes se omiten.

Relación con la integración de Git de Dataverse

El formato de control de código fuente de YAML es el formato canónico que usa la integración de Git de Dataverse. Cuando los creadores confirman soluciones de Power Apps, los archivos escritos en Azure DevOps usan este formato. Los desarrolladores de code-first pueden trabajar con el mismo repositorio mediante las herramientas de la CLI que se describen aquí.

Para obtener información sobre cómo conectar entornos a Git, consulte Configuración de integración de Git de Dataverse.

Contenido relacionado

• Herramienta SolutionPackager
• Control de código fuente con archivos de solución
• paquete de solución pac
• Descomprimir la solución pac
• Introducción a la integración de Git de Dataverse