Skip to content

Upgrade to support unify config and aad manifest

turenlong edited this page Apr 26, 2022 · 6 revisions

We will update the configuration files so that your project is compatible with the latest Teams Toolkit features, including a consistent configuration file schema, a single Teams app manifest template across local and remote environments, and an AAD manifest template file.

Important Notes: If you collaborate on this project with your co-workers, please ensure your team members update the Teams Toolkit extension to the latest version after committing the changes with this upgrade.

Why upgrade

Teams Toolkit continues to improve your Teams application development experience. We are upgrading the Teams app project structure so that you can:

  1. Use a consistent schema to manage configuration settings for local and remote environments.
  2. Use a single Teams application manifest template across local and remote environments.
  3. Use AAD manifest template to customize your AAD app.
  4. Allow to add single sign-on (SSO) feature for Bot (hosting on Azure App Service), Static Launch Page, and Embed existing web App

Know about the changes we made

After the project upgrade, the new file structure will consist:

  • localSettings.json will be updated to config.local.json to ensure consistency between local and remote environment configuration settings.
  • manifest.local.template.json and manifest.remote.template.json will be merged into a single manifest template file named manifest.template.json to make managing manifest template files easy.
  • Update .fx\configs\projectSettings.json capabilities to include TabSSO and/or BotSSO based on original project capabilities.
  • AAD manifest template file will be added to templates\appPackage\aad.template.json
  • The required resource access information in permissions.json file will be merged into aad.template.json file and permissions.json file will be deprecated.

Your existing localSettings.json, manifest.local.template.json, manifest.remote.template.json and projectSettings.json files will be backed up in .backup folder.

Know what you need to do

Since Teams Toolkit will use manifest.remote.template.json as a single manifest template file after the upgrade, if you have customized the manifest.local.template.json, you will need to update the manifest.template.json to include your change.

Know about how to restore your project

If anything went wrong after the upgrade process, you could restore your old project configuration files by:

  • Copy the .backup/.fx folder to your project root path.
  • Copy the .backup/templates folder to your project root path.
  • Delete config.local.json, manifest.template.json and aad.template.json if needed.
Clone this wiki locally