Personalizar el manifiesto de la aplicación

  • Artículo

El manifiesto de aplicación (anteriormente denominado manifiesto de aplicación de Teams) describe cómo se integra la aplicación en Microsoft Teams. Después del scaffolding, el archivo de manifiesto de aplicación predeterminado está disponible en appPackage/manifest.json. El archivo de manifiesto de la aplicación contiene algunas variables de entorno con el formato , ${{XX_XX}}y los valores reales se resuelven mediante el kit de herramientas de Microsoft Teams con archivos de desarrollo como env/.env.dev y env/.env.local.

Para obtener una vista previa del manifiesto de la aplicación con contenido real, Teams Toolkit genera los archivos de manifiesto de la aplicación en versión preliminar en appPackage/build la carpeta :

└───appPackage
    └───build
        ├───appPackage.{env}.zip - Zipped app package of remote Teams app
        ├───appPackage.local.zip - Zipped app package of local Teams app
        ├───manifest.{env}.json  - Previewed manifest of remote Teams app
        └───manifest.local.json  - Previewed manifest of local Teams app

Puede obtener una vista previa del archivo de manifiesto de la aplicación en entornos locales y quitarlo.

Vista previa del archivo de manifiesto de la aplicación en el entorno local

Para obtener una vista previa del archivo de manifiesto de la aplicación en el entorno local, puede presionar F5 para ejecutar la depuración local. Después de generar las variables de entorno en env/.env.local, el paquete de la aplicación y el manifiesto de la aplicación en versión preliminar se compilan en la appPackage/build carpeta .

También puede desencadenar Zip Teams App Package desde la vista de árbol o Teams: Zip Teams app Package desde la paleta de comandos para generar el manifiesto de aplicación en versión preliminar y el paquete de la aplicación.

Captura de pantalla que muestra la selección del paquete zip de la aplicación de Teams.

Vista previa del archivo de manifiesto de la aplicación en un entorno remoto

Para obtener una vista previa del archivo de manifiesto de la aplicación en un entorno remoto, puede desencadenar Provision desde la vista de árbol o Teams: Provision in the cloud desde la paleta de comandos. Genera variables de entorno para la aplicación remota de Teams, compila el paquete de la aplicación y el manifiesto de la aplicación en versión preliminar en appPackage/build la carpeta .

También puede desencadenar Zip Teams App Package desde la vista de árbol o Teams: Zip Teams app Package desde la paleta de comandos para generar el manifiesto de la aplicación en versión preliminar y el paquete de la aplicación.

Captura de pantalla que muestra la selección del paquete de aplicación zip de Teams en el archivo de manifiesto de la aplicación en versión preliminar.

Personalización del manifiesto de la aplicación para Visual Studio Code

Durante la depuración o el aprovisionamiento local, el kit de herramientas de Teams carga el manifiesto de la aplicación desde y resuelve el manifiesto de appPackage/manifest.json la aplicación por variables de entorno definidas en env/.env.xxy, a continuación, crea o actualiza la aplicación teams en el Portal para desarrolladores de Teams.

  1. Puede definir su propio archivo de manifest.json en teamsapp.yml y teamsapp.local.yml. Por ejemplo, puede colocar el archivo manifest.json en test/test.jsony actualizar los manifestPath parámetros en archivos yaml.

    - uses: teamsApp/zipAppPackage # Build Teams app package with latest env value
  with:
  manifestPath: ./test/test.json # Path to manifest template
  outputZipPath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
  outputJsonPath: ./appPackage/build/manifest.${{TEAMSFX_ENV}}.json

  2. Puede definir sus propias variables de entorno. El manifest.json predeterminado contiene algunos marcadores de posición con el formato ${{xx_xx}}. Puede definir sus propias variables de entorno y agregar marcadores de posición en el archivo manifest.json. Por ejemplo, puede personalizar la descripción de la aplicación definiendo una nueva variable de entorno en el archivo env/.env.xx y actualizando manifest.json con el marcador de posición correspondiente.

    .env.dev

    TEAMS_APP_DESCRIPTION=This is an amazing app

    manifest.json

    {
    "$schema": "https://developer.microsoft.com/en-us/json-schemas/teams/v1.16/MicrosoftTeams.schema.json",
    "manifestVersion": "1.16",
    "description": {
        "short": "${{TEAMS_APP_DESCRIPTION}}",
        "full": "Full description of tab0418"
    },
}

Validación de la aplicación

Después de la personalización, es posible que quiera validar el manifiesto de la aplicación o el paquete de la aplicación. Puede desencadenar Validate Application desde la vista de árbol o Teams: ValidateApplication desde la paleta de comandos. Hay dos opciones, Validate using manifest schema o Validate app package using validation rules.

Captura de pantalla que muestra la selección de validar la aplicación en la utilidad.

Validación mediante el esquema de manifiesto de aplicación

Esta opción se representa appPackage/manifest.json con variables de entorno y, a continuación, valida el manifiesto de la aplicación con su esquema.

Captura de pantalla que muestra la selección de validación mediante el esquema de manifiesto.

Comando de la CLI:

teamsfx validate --manifest-path YOUR-PATH-TO-MANIFEST

Si cumple , MissingEnvironmentVariablesErrorsignifica que teams Toolkit no puede encontrar las variables de entorno correspondientes definidas en manifest.json. Es posible que tenga que ejecutar Aprovisionar o F5 para generar variables de entorno o actualizar .env.xx manualmente el archivo para cumplir el valor.

Captura de pantalla que muestra el error de variables de entorno que faltan.

Validación del paquete de la aplicación mediante reglas de validación

Esta opción valida el paquete de la aplicación comprimida con reglas de validación.

Captura de pantalla que muestra la selección de Validar paquete de aplicación mediante reglas de validación.

Comando de la CLI:

teamsfx validate --app-package-file-path YOUR-PATH-TO-APP-PACKAGE

Tiene otras reglas de validación que el esquema de manifiesto de la aplicación. Por ejemplo, si la sección de pestaña estática tiene entityId "conversations" y el nombre, aparece el siguiente error:

Captura de pantalla que muestra la salida de validación.

Actualización de la aplicación Teams

Después de obtener una vista previa y validar el archivo de manifiesto de la aplicación, puede sincronizar los cambios locales con el Portal para desarrolladores de Teams desencadenando Teams: Update Teams app el comando desde la paleta de comandos:

Captura de pantalla que muestra la selección de la aplicación teams update de Teams.

Comando de la CLI:

teamsfx update teams-app

Nota:

El cambio se refleja en el Portal para desarrolladores. Las actualizaciones manuales del Portal para desarrolladores se sobrescriben.

Si el archivo de manifiesto de la aplicación no está actualizado debido al cambio de archivo de configuración o al cambio de plantilla, seleccione cualquiera de las siguientes acciones:

  • Solo versión preliminar: el archivo de manifiesto de aplicación local se sobrescribe según la configuración actual.
  • Versión preliminar y actualización: el archivo de manifiesto de la aplicación local se sobrescribe según la configuración actual y también se actualiza a la plataforma Teams.
  • Cancelar: no se realiza ninguna acción.

Para obtener una vista previa de los valores del entorno local y de desarrollo

En appPackage/manifest.json, puede ir a CodeLens para obtener una vista previa de los valores de local y dev del entorno.

Captura de pantalla que muestra codelens v5.

Nota:

Aprovisione el entorno o ejecute la depuración local para generar variables de entorno.

Puede ir al .env archivo seleccionando CodeLens, que proporciona una lista desplegable con todos los nombres de entorno. Después de seleccionar un entorno, se abre el archivo correspondiente .env .

Captura de pantalla que muestra la selección de desarrollo.

Para obtener una vista previa de los valores de todo el entorno, puede mantener el puntero sobre el marcador de posición. Muestra una lista de nombres de entorno y valores correspondientes. Si no ha aprovisionado el entorno o ha ejecutado la depuración local, es posible que la variable de entorno no exista. Seleccione Trigger Teams: Provision in the cloud command to see placeholder value o Trigger local debug to see placeholder value.

Captura de pantalla que muestra el marcador de posición cuando se mantiene el puntero muestra una lista con los nombres de entorno y los valores correspondientes.

Vea también