@microsoft/teamsfx-core 1.23.3 → 2.0.0-alpha.14ea2b310.0

package/templates/core/v3Migration/js.ts.app.yml

@@ -1,17 +1,40 @@
+# yaml-language-server: $schema=https://developer.microsoft.com/json-schemas/teams-toolkit/teamsapp-yaml/1.0.0/yaml.schema.json
+# Visit https://aka.ms/teamsfx-v5.0-guide for details on this file
+# Visit https://aka.ms/teamsfx-actions for details on actions
 version: 1.0.0
 
 projectId: {{projectId}}
 
 environmentFolderPath: ./ {{~environmentFolder}}
 
+# Triggered when 'teamsfx provision' is executed
 provision:
+{{#if activePlugins.fx-resource-aad-app-for-teams}}
+  - uses: aadApp/create # Creates a new Azure Active Directory (AAD) app to authenticate users if the environment variable that stores clientId is empty
+    with:
+      name: {{aadAppName}} # Note: when you run aadApp/update, the AAD app name will be updated based on the definition in manifest. If you don't want to change the name, make sure the name in AAD manifest is the same with the name defined here.
+      generateClientSecret: true # If the value is false, the action will not generate client secret for you
+      signInAudience: "AzureADMyOrg" # Authenticate users with a Microsoft work or school account in your organization's Azure AD tenant (for example, single tenant).
+    writeToEnvironmentFile: # Write the information of created resources into environment file for the specified environment variable(s).
+      clientId: AAD_APP_CLIENT_ID
+      clientSecret: SECRET_AAD_APP_CLIENT_SECRET # Environment variable that starts with `SECRET_` will be stored to the .env.{envName}.user environment file
+      objectId: AAD_APP_OBJECT_ID
+      tenantId: AAD_APP_TENANT_ID
+      authority: AAD_APP_OAUTH_AUTHORITY
+      authorityHost: AAD_APP_OAUTH_AUTHORITY_HOST
+{{/if}}
+  - uses: teamsApp/create # Creates a Teams app
+    with:
+      name: {{teamsAppName}} # Teams app name
+    writeToEnvironmentFile:
+      teamsAppId: TEAMS_APP_ID
 {{#if activePlugins.fx-resource-bot}}
   - uses: botAadApp/create # Creates a new AAD app for Bot Registration.
     with:
       name: {{appName}}bt$\{{RESOURCE_SUFFIX}}
-    # Output: following environment variable will be persisted in current environment's .env file.
-    # BOT_ID: the AAD app client id created for Bot Registration.
-    # SECRET_BOT_PASSWORD: the AAD app client secret created for Bot Registration.
+    writeToEnvironmentFile:
+      botId: BOT_ID
+      botPassword: SECRET_BOT_PASSWORD
 {{/if}}
   - uses: arm/deploy # Deploy given ARM templates parallelly.
     with:
@@ -22,23 +45,52 @@ provision:
          parameters: ./templates/azure/azure.parameters.$\{{TEAMSFX_ENV}}.json # Relative path to this file. Placeholders will be replaced with corresponding environment variable before ARM deployment.
          deploymentName: teams_toolkit_deployment # Required when deploy ARM template
       bicepCliVersion: v0.4.613 # Teams Toolkit will download this bicep CLI version from github for you, will use bicep CLI in PATH if you remove this config.
-    # Output: every bicep output will be persisted in current environment's .env file with certain naming conversion. Refer https://aka.ms/teamsfx-provision-arm#output for more details on the naming conversion rule.
 {{#if activePlugins.fx-resource-frontend-hosting}}
   - uses: azureStorage/enableStaticWebsite
     with:
       storageResourceId: $\{{ {{~placeholderMappings.[state.fx-resource-frontend-hosting.storageResourceId]~}} }}
       indexPage: index.html
       errorPage: error.html
-    # Output: N/A
+{{/if}}
+{{#if activePlugins.fx-resource-aad-app-for-teams}}
+  - uses: aadApp/update # Apply the AAD manifest to an existing AAD app. Will use the object id in manifest file to determine which AAD app to update.
+    with:
+      manifestPath: ./aad.manifest.json # Relative path to this file. Environment variables in manifest will be replaced before apply to AAD app
+      outputFilePath : ./build/aad.manifest.$\{{TEAMSFX_ENV}}.json
+{{/if}}
+  - uses: teamsApp/validateManifest # Validate using manifest schema
+    with:
+      manifestPath: ./appPackage/manifest.json # Path to manifest template
+  - uses: teamsApp/zipAppPackage # Build Teams app package with latest env value
+    with:
+      manifestPath: ./appPackage/manifest.json # Path to manifest template
+      outputZipPath: ./build/appPackage/appPackage.$\{{TEAMSFX_ENV}}.zip
+      outputJsonPath: ./build/appPackage/manifest.$\{{TEAMSFX_ENV}}.json
+  - uses: teamsApp/validateAppPackage # Validate app package using validation rules
+    with:
+      appPackagePath: ./build/appPackage/appPackage.$\{{TEAMSFX_ENV}}.zip # Relative path to this file. This is the path for built zip file.
+  - uses: teamsApp/update # Apply the Teams app manifest to an existing Teams app in Teams Developer Portal. Will use the app id in manifest file to determine which Teams app to update.
+    with:
+      appPackagePath: ./build/appPackage/appPackage.$\{{TEAMSFX_ENV}}.zip # Relative path to this file. This is the path for built zip file.
+{{#if isM365}}
+  - uses: m365Title/acquire # Upload your app to Outlook and the Microsoft 365 app
+    with:
+      appPackagePath: ./build/appPackage/appPackage.$\{{TEAMSFX_ENV}}.zip # Relative path to the built app package.
+    writeToEnvironmentFile: # Write the information of created resources into environment file for the specified environment variable(s).
+      titleId: M365_TITLE_ID
+      appId: M365_APP_ID
 {{/if}}
 
+# Triggered when 'teamsfx deploy' is executed
 deploy:
 {{#if activePlugins.fx-resource-frontend-hosting}}
   - uses: cli/runNpmCommand # Run npm command
+    name: install tab dependencies
     with:
       workingDirectory: tabs
       args: install
   - uses: cli/runNpmCommand # Run npm command
+    name: build tab app
     {{#if activePlugins.fx-resource-aad-app-for-teams}}
     env:
       REACT_APP_CLIENT_ID: $\{{AAD_APP_CLIENT_ID}}
@@ -51,72 +103,72 @@ deploy:
     with:
       workingDirectory: tabs
       args: run build --if-present
-  - uses: azureStorage/deploy # Deploy bits to Azure Storage Static Website
+  # Deploy bits to Azure Storage Static Website
+  - uses: azureStorage/deploy
     with:
       workingDirectory: tabs
-      distributionPath: build # Deploy base folder. This folder includes manifest files for AAD app and Teams app that should be ignored using the ignoreFile.
-      ignoreFile:  # Can be changed to any ignore file location, leave blank will ignore nothing
-      resourceId: $\{{ {{~placeholderMappings.[state.fx-resource-frontend-hosting.storageResourceId]~}} }} # The resource id of the cloud resource to be deployed to. This key will be generated by arm/deploy action automatically. You can replace it with your existing Azure Resource id or add it to your environment variable file.
+      # Deploy base folder. This folder includes manifest files for AAD app and Teams app that should be ignored using the ignoreFile.
+      artifactFolder: build
+      # The resource id of the cloud resource to be deployed to. This key will be generated by arm/deploy action automatically. You can replace it with your existing Azure Resource id or add it to your environment variable file.
+      resourceId: $\{{ {{~placeholderMappings.[state.fx-resource-frontend-hosting.storageResourceId]~}} }}
 {{/if}}
 {{#if activePlugins.fx-resource-bot}}
   {{#if isFunctionBot}}
   - uses: cli/runNpmCommand
+    name: install bot dependencies
     with:
       workingDirectory: bot
       args: install
     {{#if isTypescript}}
   - uses: cli/runNpmCommand
+    name: build bot app
     with:
       workingDirectory: bot
       args: run build --if-present
     {{/if}}
-  - uses: azureFunctions/deploy
+  # Deploy your application to Azure Functions using the zip deploy feature.
+  # For additional details, please refer to https://aka.ms/zip-deploy-to-azure-functions
+  - uses: azureFunctions/zipDeploy
     with:
       workingDirectory: bot
-      distributionPath: . # Deploy base folder
-      ignoreFile: .funcignore # Can be changed to any ignore file location, leave blank will ignore nothing
-      # the resource id of the cloud resource to be deployed to. This key will be generated by arm/deploy action automatically. You can replace it with your existing Azure Resource id or add it to your environment variable file.
-      resourceId: $\{{ {{~placeholderMappings.[state.fx-resource-bot.functionAppResourceId]~}} }}
+      # Deploy base folder
+      artifactFolder: .
+      # Can be changed to any ignore file location, leave blank will ignore nothing
+      ignoreFile: .funcignore
+      # The resource id of the cloud resource to be deployed to. This key will be generated by arm/deploy action automatically. You can replace it with your existing Azure Resource id or add it to your environment variable file.
+      resourceId: $\{{ {{~botResourceId~}} }}
   {{else}}
-  {{#if isWebAppBot}}
   - uses: cli/runNpmCommand # Run npm command
+    name: install bot dependencies
     with:
       workingDirectory: bot
       args: install
     {{#if isTypescript}}
   - uses: cli/runNpmCommand # Run npm command
+    name: build bot app
     with:
       workingDirectory: bot
       args: run build --if-present
     {{/if}}
-  - uses: azureAppService/deploy # Deploy bits to Azure App Service
+  # Deploy your application to Azure App Service using the zip deploy feature.
+  # For additional details, please refer to https://aka.ms/zip-deploy-to-app-services.
+  - uses: azureAppService/zipDeploy
     with:
       workingDirectory: bot
-      distributionPath: . # Deploy base folder. 
-      ignoreFile: # Can be changed to any ignore file location, leave blank will ignore nothing
-      resourceId: $\{{ {{~placeholderMappings.[state.fx-resource-bot.botWebAppResourceId]~}} }} # The resource id of the cloud resource to be deployed to. This key will be generated by arm/deploy action automatically. You can replace it with your existing Azure Resource id or add it to your environment variable file.
-  {{else}}
-  - uses: cli/runNpmCommand # Run npm command
-    with:
-      workingDirectory: bot
-      args: install
-    {{#if isTypescript}}
-  - uses: cli/runNpmCommand # Run npm command
-    with:
-      workingDirectory: bot
-      args: run build --if-present
-    {{/if}}
-  - uses: azureAppService/deploy # Deploy bits to Azure App Service
-    with:
-      workingDirectory: bot
-      distributionPath: . # Deploy base folder. 
-      ignoreFile: # Can be changed to any ignore file location, leave blank will ignore nothing
-      resourceId: $\{{ {{~placeholderMappings.[state.fx-resource-bot.resourceId]~}} }} # The resource id of the cloud resource to be deployed to. This key will be generated by arm/deploy action automatically. You can replace it with your existing Azure Resource id or add it to your environment variable file.
-  {{/if}}
+      # Deploy base folder.
+      artifactFolder: .
+      # The resource id of the cloud resource to be deployed to. This key will be generated by arm/deploy action automatically. You can replace it with your existing Azure Resource id or add it to your environment variable file.
+      resourceId: $\{{ {{~botResourceId~}} }}
   {{/if}}
 {{/if}}
 {{#if activePlugins.fx-resource-function}}
+  - uses: prerequisite/install # Install dependencies
+    with:      
+      dotnet: true
+    writeToEnvironmentFile: # Write the information of installed dependencies into environment file for the specified environment variable(s).
+      dotnetPath: DOTNET_PATH
   - uses: cli/runNpmCommand
+    name: install api dependencies
     with:
       workingDirectory: api
       args: install
@@ -124,50 +176,30 @@ deploy:
     with:
       workingDirectory: api
       args: build extensions.csproj -o bin --ignore-failed-sources
+      execPath: $\{{ {{~dotnetPath~}} }} # Use dotnet installed by prerequisite/install action
     {{#if isTypescript}}
   - uses: cli/runNpmCommand
+    name: build api app
     with:
       workingDirectory: api
       args: run build --if-present
     {{/if}}
-  - uses: azureFunctions/deploy
+  # Deploy your application to Azure Functions using the zip deploy feature.
+  # For additional details, please refer to https://aka.ms/zip-deploy-to-azure-functions
+  - uses: azureFunctions/zipDeploy
     with:
       workingDirectory: api
-      distributionPath: . # Deploy base folder
-      ignoreFile: .funcignore # Can be changed to any ignore file location, leave blank will ignore nothing
-      resourceId: $\{{ {{~placeholderMappings.[state.fx-resource-function.functionAppResourceId]~}} }} # The resource id of the cloud resource to be deployed to. This key will be generated by arm/deploy action automatically. You can replace it with your existing Azure Resource id or add it to your environment variable file.
+      # Deploy base folder
+      artifactFolder: .
+      # Can be changed to any ignore file location, leave blank will ignore nothing
+      ignoreFile: .funcignore
+      # The resource id of the cloud resource to be deployed to. This key will be generated by arm/deploy action automatically. You can replace it with your existing Azure Resource id or add it to your environment variable file.
+      resourceId: $\{{ {{~placeholderMappings.[state.fx-resource-function.functionAppResourceId]~}} }}
 {{/if}}
 
-registerApp:
-{{#if activePlugins.fx-resource-aad-app-for-teams}}
-  - uses: aadApp/create # Creates a new AAD app to authenticate users if AAD_APP_CLIENT_ID environment variable is empty
-    with:
-      name: {{aadAppName}} # Note: when you run configure/aadApp, the AAD app name will be updated based on the definition of manifest. If you don't want to change the name, ensure the name in AAD manifest is same with the name defined here.
-      generateClientSecret: true # If the value is false, the action will not generate client secret for you
-    # Output: following environment variable will be persisted in current environment's .env file.
-    # AAD_APP_CLIENT_ID: the client id of AAD app
-    # SECRET_AAD_APP_CLIENT_SECRET: the client secret of AAD app
-    # AAD_APP_OBJECT_ID: the object id of AAD app
-    # AAD_APP_TENANT_ID: the tenant id of AAD app
-    # AAD_APP_OAUTH_AUTHORITY_HOST: the host of OAUTH authority of AAD app
-    # AAD_APP_OAUTH_AUTHORITY: the OAUTH authority of AAD app
-{{/if}}
-  - uses: teamsApp/create # Creates a Teams app
-    with:
-      name: {{teamsAppName}} # Teams app name
-    # Output: following environment variable will be persisted in current environment's .env file.
-    # TEAMS_APP_ID: the id of Teams app
-
-configureApp:
-{{#if activePlugins.fx-resource-aad-app-for-teams}}
-  - uses: aadApp/update # Apply the AAD manifest to an existing AAD app. Will use the object id in manifest file to determine which AAD app to update.
-    with:
-      manifestPath: ./aad.manifest.template.json # Relative path to this file. Environment variables in manifest will be replaced before apply to AAD app
-      outputFilePath : ./build/aad.manifest.$\{{TEAMSFX_ENV}}.json
-  # Output: following environment variable will be persisted in current environment's .env file.
-  # AAD_APP_ACCESS_AS_USER_PERMISSION_ID: the id of access_as_user permission which is used to enable SSO
-{{/if}}
-  - uses: teamsApp/validate
+# Triggered when 'teamsfx publish' is executed
+publish:
+  - uses: teamsApp/validateManifest # Validate using manifest schema
     with:
       manifestPath: ./appPackage/manifest.json # Path to manifest template
   - uses: teamsApp/zipAppPackage # Build Teams app package with latest env value
@@ -175,23 +207,15 @@ configureApp:
       manifestPath: ./appPackage/manifest.json # Path to manifest template
       outputZipPath: ./build/appPackage/appPackage.$\{{TEAMSFX_ENV}}.zip
       outputJsonPath: ./build/appPackage/manifest.$\{{TEAMSFX_ENV}}.json
-  - uses: teamsApp/update # Apply the Teams app manifest to an existing Teams app. Will use the app id in manifest file to determine which Teams app to update.
+  - uses: teamsApp/validateAppPackage # Validate app package using validation rules
     with:
       appPackagePath: ./build/appPackage/appPackage.$\{{TEAMSFX_ENV}}.zip # Relative path to this file. This is the path for built zip file.
-    # Output: following environment variable will be persisted in current environment's .env file.
-    # TEAMS_APP_ID: the id of Teams app
-
-publish:
-  - uses: teamsApp/validate
-    with:
-      manifestPath: ./appPackage/manifest.json # Path to manifest template
-  - uses: teamsApp/zipAppPackage
+  - uses: teamsApp/update # Apply the Teams app manifest to an existing Teams app in Teams Developer Portal. Will use the app id in manifest file to determine which Teams app to update.
     with:
-      manifestPath: ./appPackage/manifest.json # Path to manifest template
-      outputZipPath: ./build/appPackage/appPackage.$\{{TEAMSFX_ENV}}.zip
-      outputJsonPath: ./build/appPackage/manifest.$\{{TEAMSFX_ENV}}.json
-  - uses: teamsApp/publishAppPackage # Publish the app to Teams app catalog
+      appPackagePath: ./build/appPackage/appPackage.$\{{TEAMSFX_ENV}}.zip # Relative path to this file. This is the path for built zip file.
+  - uses: teamsApp/publishAppPackage # Publish the app to Teams Admin Center (https://admin.teams.microsoft.com/policies/manage-apps) for review and approval
     with:
       appPackagePath: ./build/appPackage/appPackage.$\{{TEAMSFX_ENV}}.zip
-  # Output: following environment variable will be persisted in current environment's .env file.
-  # TEAMS_APP_PUBLISHED_APP_ID: app id in Teams tenant app catalog.
+    writeToEnvironmentFile:
+      # Write the information of created resources into environment file for the specified environment variable(s).
+      publishedAppId: TEAMS_APP_PUBLISHED_APP_ID

package/templates/core/v3Migration/spfx.app.yml

@@ -1,49 +1,54 @@
+# yaml-language-server: $schema=https://developer.microsoft.com/json-schemas/teams-toolkit/teamsapp-yaml/1.0.0/yaml.schema.json
+# Visit https://aka.ms/teamsfx-v5.0-guide for details on this file
+# Visit https://aka.ms/teamsfx-actions for details on actions
 version: 1.0.0
 
+projectId: {{projectId}}
+
 environmentFolderPath: ./ {{~environmentFolder}}
 
+# Triggered when 'teamsfx provision' is executed
+provision:
+  - uses: teamsApp/create # Creates a Teams app
+    with:
+      name: {{teamsAppName}} # Teams app name
+    writeToEnvironmentFile:
+      # Write the information of created resources into environment file for the specified environment variable(s).
+      teamsAppId: TEAMS_APP_ID
+  - uses: teamsApp/validateManifest # Validate using manifest schema
+    with:
+      manifestPath: ./appPackage/manifest.json # Path to manifest template
+  - uses: teamsApp/zipAppPackage # Build Teams app package with latest env value
+    with:
+      manifestPath: ./appPackage/manifest.json # Path to manifest template
+      outputZipPath: ./build/appPackage/appPackage.$\{{TEAMSFX_ENV}}.zip
+      outputJsonPath: ./build/appPackage/manifest.$\{{TEAMSFX_ENV}}.json
+  - uses: teamsApp/update # Apply the Teams app manifest to an existing Teams app. Will use the app id in manifest file to determine which Teams app to update.
+    with:
+      appPackagePath: ./build/appPackage/appPackage.$\{{TEAMSFX_ENV}}.zip # Relative path to this file. This is the path for built zip file.
+
+# Triggered when 'teamsfx deploy' is executed
 deploy:
   - uses: cli/runNpmCommand
     with:
       args: install
-      workingDirectory: ./SPFx
+      workingDirectory: SPFx
   - uses: cli/runNpxCommand
     with:
-      workingDirectory: ./SPFx
+      workingDirectory: SPFx
       args: gulp bundle --ship --no-color
   - uses: cli/runNpxCommand
     with:
-      workingDirectory: ./SPFx
+      workingDirectory: SPFx
       args: gulp package-solution --ship --no-color
   - uses: spfx/deploy
     with:
       createAppCatalogIfNotExist: false
       packageSolutionPath: ./SPFx/config/package-solution.json
 
-registerApp:
-  - uses: teamsApp/create # Creates a Teams app
-    with:
-      name: {{teamsAppName}} # Teams app name
-    # Output: following environment variable will be persisted in current environment's .env file.
-    # TEAMS_APP_ID: the id of Teams app
-
-configureApp:
-  - uses: teamsApp/validate
-    with:
-      manifestPath: ./appPackage/manifest.json # Path to manifest template
-  - uses: teamsApp/zipAppPackage # Build Teams app package with latest env value
-    with:
-      manifestPath: ./appPackage/manifest.json # Path to manifest template
-      outputZipPath: ./build/appPackage/appPackage.$\{{TEAMSFX_ENV}}.zip
-      outputJsonPath: ./build/appPackage/manifest.$\{{TEAMSFX_ENV}}.json
-  - uses: teamsApp/update # Apply the Teams app manifest to an existing Teams app. Will use the app id in manifest file to determine which Teams app to update.
-    with:
-      appPackagePath: ./build/appPackage/appPackage.$\{{TEAMSFX_ENV}}.zip # Relative path to this file. This is the path for built zip file.
-    # Output: following environment variable will be persisted in current environment's .env file.
-    # TEAMS_APP_ID: the id of Teams app
-
+# Triggered when 'teamsfx publish' is executed
 publish:
-  - uses: teamsApp/validate
+  - uses: teamsApp/validateManifest # Validate using manifest schema
     with:
       manifestPath: ./appPackage/manifest.json # Path to manifest template
   - uses: teamsApp/zipAppPackage
@@ -51,12 +56,15 @@ publish:
       manifestPath: ./appPackage/manifest.json # Path to manifest template
       outputZipPath: ./build/appPackage/appPackage.$\{{TEAMSFX_ENV}}.zip
       outputJsonPath: ./build/appPackage/manifest.$\{{TEAMSFX_ENV}}.json
-  - uses: teamsApp/copyAppPackageForSPFx
+  - uses: teamsApp/copyAppPackageToSPFx
     with:
       appPackagePath: ./build/appPackage/appPackage.$\{{TEAMSFX_ENV}}.zip
       spfxFolder: ./SPFx
-  - uses: teamsApp/publishAppPackage # Publish the app to Teams app catalog
+  - uses: teamsApp/update # Apply the Teams app manifest to an existing Teams app in Teams Developer Portal. Will use the app id in manifest file to determine which Teams app to update.
+    with:
+      appPackagePath: ./build/appPackage/appPackage.$\{{TEAMSFX_ENV}}.zip # Relative path to this file. This is the path for built zip file.
+  - uses: teamsApp/publishAppPackage # Publish the app to Teams Admin Center (https://admin.teams.microsoft.com/policies/manage-apps) for review and approval
     with:
       appPackagePath: ./build/appPackage/appPackage.$\{{TEAMSFX_ENV}}.zip
-  # Output: following environment variable will be persisted in current environment's .env file.
-  # TEAMS_APP_PUBLISHED_APP_ID: app id in Teams tenant app catalog.
+    writeToEnvironmentFile:
+      publishedAppId: TEAMS_APP_PUBLISHED_APP_ID

package/templates/core/v3Migration/upgradeReport.md

@@ -0,0 +1,48 @@
+# Upgrade Summary
+
+Congratulations! You can continue your development now. Your project has been upgraded to work with the latest Teams Toolkit.
+
+Most of existing features behave similar with previous Teams Toolkit. You can visit https://aka.ms/teamsfx-v5.0-guide to learn the new features. And read [Important changes to your development flow](#important-changes-to-your-development-flow) to understand the changes to your development flow.
+
+Visit https://aka.ms/teams-toolkit-5.0-upgrade to learn more about the upgrade.
+
+## Important changes to your development flow
+
+There's no immediate action required from you. This part illustrates what's changed to your development flow.
+> If you encountered any errors or issues after upgrade, you could try the following steps or visit [known issues](https://aka.ms/teams-toolkit-5.0-upgrade#known-issues) for details.
+
+1. You need to sync `env/.env.{env}.user` files between different machines manually. All these files will be gitignored by default. [Learn More](https://aka.ms/teams-toolkit-5.0-upgrade#environment-management)
+2. You need to take some manual steps when creating or provisioning new environments for your old project. [Learn More](https://aka.ms/teams-toolkit-5.0-upgrade#environment-management)
+3. You need to manually update `.vscode/launch.json` when launching your app for a certain environment if your current project contains it. [Learn More](https://aka.ms/teams-toolkit-5.0-upgrade#launch-your-app)
+4. You need to provide values to `APIM__PUBLISHEREMAIL` and `APIM__PUBLISHERNAME` environment variable if your current project uses APIM. [Learn More](https://aka.ms/teams-toolkit-5.0-upgrade#provision-apim-service)
+
+You can visit this [wiki](https://aka.ms/teams-toolkit-5.0-upgrade#feature-changes-that-impact-your-development-flow) to learn more changes to Teams Toolkit.
+
+## Changes to your project
+
+1. Created `teamsapp.yml` and `teamsapp.local.yml` in your project root folder.
+2. Moved environment files in `.fx` to `.env.{env}` in `env` folder.
+3. If your project contains file `.fx/states/{env}.userdata`, the content will be moved to `.env.{env}.user` in `env` folder
+4. Moved `templates/appPackage` to `appPackage`, renamed `manifest.template.json` to `manifest.json` and placeholders in it will be updated per the latest Teams Toolkit requirement.
+5. If your project contains file `templates/appPackage/aad.template.json`, it will be moved and renamed as `aad.manifest.json` and placeholders in it will be updated per the latest Teams Toolkit requirement.
+6. If your project contains file `.vscode/tasks.json` and `.vscode/launch.json`, they will be updated.
+7. Updated `.gitignore` to ignore new environment user files.8. Removed `.fx` folder.
+8. Removed `.fx` folder.
+
+For more detailed changes, please refer to this [wiki](https://aka.ms/teams-toolkit-5.0-upgrade#file-changes).
+
+## Known issues
+
+1. If your project only contains a bot, you may meet error that complains `STATE__FX_RESOURCE_FRONTEND_HOSTING__ENDPOINT` is missing when executing commands. Replace this placeholder with a valid URL in `appPackage/manifest.json` to fix it. [Learn More](https://aka.ms/teams-toolkit-5.0-upgrade#state__fx_resource_frontend_hosting__endpoint-missing-error-in-some-projects)
+
+2. If your project is created with Viusal Studio version < 17.4, you may see error `InvalidParameter: Following parameter is missing or invalid for aadApp/create action: name` when executing commands. Please follow [the steps](#how-to-roll-back) to roll back, install VS 17.4 and run upgrade first.
+
+3. If your tab app is created with Teams Toolkit 3.2.0 or earlier version, you may see error `simpleAuthEndpoint in configuration is invalid` when remote debugging your app. Please follow this [wiki]( `https://aka.ms/teams-toolkit-5.0-upgrade#simpleauthendpoint-in-configuration-is-invalid`) to learn how to mitigate this error.
+
+## How to roll back
+
+If you want to restore your project configuration after the upgrade is successful and continue to use old version Teams Toolkit, you can follow these steps:
+1. Copy everything in `.backup` folder to your project root folder
+2. Delete the new files mentioned in [Changes to your project](#changes-to-your-project) section
+
+You can learn more details in this [wiki](https://aka.ms/teams-toolkit-5.0-upgrade#how-to-roll-back).

package/templates/plugins/resource/aad/auth/bot/README.txt

@@ -20,7 +20,7 @@ Actions required - update your code to add SSO authentication
 Note: This part is for `command and response bot`.
 
 1. Please upgrade your SDK and make sure your SDK version:
-   TeamsFx: >= 2.2.0
+   TeamsFx: >= 1.1.0
    Microsoft.Bot.Builder >= 4.17.1
 
 2. Create "Pages" folder and move files in `Auth/bot/Pages` folder to `Pages`

package/templates/plugins/resource/apim/README.md

@@ -4,7 +4,7 @@ Azure API Management (APIM) is used to create consistent and modern API gateways
 
 ## Prerequisite
 
-- [Node.js](https://nodejs.org/en/), supported versions: 14, 16, 18 (preview)
+- [Node.js](https://nodejs.org/), supported versions: 14, 16, 18 (preview)
 - An Microsoft 365 account. If you do not have an Microsoft 365 account, apply for one from [Microsoft 365 developer program](https://developer.microsoft.com/en-us/microsoft-365/dev-program)
 - An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/en-us/free/)
   - Ensure the resource provider 'Microsoft.ApiManagement' is registered for the subscription by following [document](https://docs.microsoft.com/en-us/azure/azure-resource-manager/templates/error-register-resource-provider#solution-3---azure-portal)

package/templates/plugins/resource/spfx/solution/README.md

@@ -39,7 +39,7 @@ Version|Date|Comments
 
 ## Minimal Path to Awesome
 
-1. Install the latest version of [Node.js LTS 16.x](https://nodejs.org/en/download/releases/) (Note: SPFx v1.16.1 support Node.js v16).
+1. Install the latest version of [Node.js LTS 16.x](https://nodejs.org/en/download/releases/) (Note: SPFx v1.16.1 supports Node.js v16).
 2. You can either download [Visual Studio Code](https://code.visualstudio.com) and install [Teams Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) or download TeamsFx CLI.
 3. Open the project with VSCode, click `Provision in the cloud` in DEPLOYMENT panel of Teams Toolkit extension.
 

package/build/component/configManager/error.d.ts

@@ -1,18 +0,0 @@
-import { UserError } from "@microsoft/teamsfx-api";
-import { LifecycleName } from "./interface";
-export declare class DriverNotFoundError extends UserError {
-    constructor(taskName: string, uses: string);
-}
-export declare class YamlParsingError extends UserError {
-    constructor(yamlPath: string, reason: Error);
-}
-export declare class InvalidLifecycleError extends UserError {
-    constructor(lifecycle: LifecycleName);
-}
-export declare class InvalidEnvFolderPath extends UserError {
-    constructor(reason?: string);
-}
-export declare class InvalidEnvFieldError extends UserError {
-    constructor(actionName: string, lifecycle: LifecycleName);
-}
-//# sourceMappingURL=error.d.ts.map

package/build/component/configManager/error.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../../src/component/configManager/error.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAoB,MAAM,wBAAwB,CAAC;AAErE,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAI5C,qBAAa,mBAAoB,SAAQ,SAAS;gBACpC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;CAW3C;AAED,qBAAa,gBAAiB,SAAQ,SAAS;gBACjC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK;CAY5C;AAED,qBAAa,qBAAsB,SAAQ,SAAS;gBACtC,SAAS,EAAE,aAAa;CAWrC;AAED,qBAAa,oBAAqB,SAAQ,SAAS;gBACrC,MAAM,CAAC,EAAE,MAAM;CAW5B;AAED,qBAAa,oBAAqB,SAAQ,SAAS;gBACrC,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,aAAa;CAWzD"}

package/build/component/configManager/error.js

@@ -1,80 +0,0 @@
-"use strict";
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InvalidEnvFieldError = exports.InvalidEnvFolderPath = exports.InvalidLifecycleError = exports.YamlParsingError = exports.DriverNotFoundError = void 0;
-const teamsfx_api_1 = require("@microsoft/teamsfx-api");
-const localizeUtils_1 = require("../../common/localizeUtils");
-const component = "ConfigManager";
-class DriverNotFoundError extends teamsfx_api_1.UserError {
-    constructor(taskName, uses) {
-        const key = "configManager.error.driverNotFound";
-        const errorOptions = {
-            source: component,
-            name: "DriverNotFoundError",
-            message: localizeUtils_1.getDefaultString(key, uses, taskName),
-            displayMessage: localizeUtils_1.getLocalizedString(key, uses, taskName),
-        };
-        errorOptions.helpLink = "https://aka.ms/teamsfx-actions/action-not-found";
-        super(errorOptions);
-    }
-}
-exports.DriverNotFoundError = DriverNotFoundError;
-class YamlParsingError extends teamsfx_api_1.UserError {
-    constructor(yamlPath, reason) {
-        const key = "configManager.error.yamlParsing";
-        const errorOptions = {
-            source: component,
-            name: "YamlParsingError",
-            message: localizeUtils_1.getDefaultString(key, yamlPath, reason.message),
-            displayMessage: localizeUtils_1.getLocalizedString(key, yamlPath, reason.message),
-        };
-        errorOptions.helpLink = "https://aka.ms/teamsfx-actions/yaml-parsing-error";
-        super(errorOptions);
-        this.innerError = reason;
-    }
-}
-exports.YamlParsingError = YamlParsingError;
-class InvalidLifecycleError extends teamsfx_api_1.UserError {
-    constructor(lifecycle) {
-        const key = "configManager.error.invalidLifecycle";
-        const errorOptions = {
-            source: component,
-            name: "InvalidLifecycleError",
-            message: localizeUtils_1.getDefaultString(key, lifecycle),
-            displayMessage: localizeUtils_1.getLocalizedString(key, lifecycle),
-        };
-        errorOptions.helpLink = "https://aka.ms/teamsfx-actions/invalid-lifecycle-error";
-        super(errorOptions);
-    }
-}
-exports.InvalidLifecycleError = InvalidLifecycleError;
-class InvalidEnvFolderPath extends teamsfx_api_1.UserError {
-    constructor(reason) {
-        const key = "configManager.error.invalidEnvFolderPath";
-        const errorOptions = {
-            source: component,
-            name: "InvalidEnvFolderPathError",
-            message: localizeUtils_1.getDefaultString(key) + `${reason ? "(" + reason + ")" : ""}`,
-            displayMessage: localizeUtils_1.getLocalizedString(key) + `${reason ? "(" + reason + ")" : ""}`,
-        };
-        errorOptions.helpLink = "https://aka.ms/teamsfx-actions/invalid-env-folder-error";
-        super(errorOptions);
-    }
-}
-exports.InvalidEnvFolderPath = InvalidEnvFolderPath;
-class InvalidEnvFieldError extends teamsfx_api_1.UserError {
-    constructor(actionName, lifecycle) {
-        const key = "configManager.error.invalidEnvField";
-        const errorOptions = {
-            source: component,
-            name: "InvalidEnvFieldError",
-            message: localizeUtils_1.getDefaultString(key, actionName, lifecycle),
-            displayMessage: localizeUtils_1.getLocalizedString(key, actionName, lifecycle),
-        };
-        errorOptions.helpLink = "https://aka.ms/teamsfx-actions/invalid-env-field-error";
-        super(errorOptions);
-    }
-}
-exports.InvalidEnvFieldError = InvalidEnvFieldError;
-//# sourceMappingURL=error.js.map

package/build/component/configManager/error.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"error.js","sourceRoot":"","sources":["../../../src/component/configManager/error.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAElC,wDAAqE;AACrE,8DAAkF;AAGlF,MAAM,SAAS,GAAG,eAAe,CAAC;AAElC,MAAa,mBAAoB,SAAQ,uBAAS;IAChD,YAAY,QAAgB,EAAE,IAAY;QACxC,MAAM,GAAG,GAAG,oCAAoC,CAAC;QACjD,MAAM,YAAY,GAAqB;YACrC,MAAM,EAAE,SAAS;YACjB,IAAI,EAAE,qBAAqB;YAC3B,OAAO,EAAE,gCAAgB,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,CAAC;YAC9C,cAAc,EAAE,kCAAkB,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,CAAC;SACxD,CAAC;QACF,YAAY,CAAC,QAAQ,GAAG,iDAAiD,CAAC;QAC1E,KAAK,CAAC,YAAY,CAAC,CAAC;IACtB,CAAC;CACF;AAZD,kDAYC;AAED,MAAa,gBAAiB,SAAQ,uBAAS;IAC7C,YAAY,QAAgB,EAAE,MAAa;QACzC,MAAM,GAAG,GAAG,iCAAiC,CAAC;QAC9C,MAAM,YAAY,GAAqB;YACrC,MAAM,EAAE,SAAS;YACjB,IAAI,EAAE,kBAAkB;YACxB,OAAO,EAAE,gCAAgB,CAAC,GAAG,EAAE,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC;YACxD,cAAc,EAAE,kCAAkB,CAAC,GAAG,EAAE,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC;SAClE,CAAC;QACF,YAAY,CAAC,QAAQ,GAAG,mDAAmD,CAAC;QAC5E,KAAK,CAAC,YAAY,CAAC,CAAC;QACpB,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC;IAC3B,CAAC;CACF;AAbD,4CAaC;AAED,MAAa,qBAAsB,SAAQ,uBAAS;IAClD,YAAY,SAAwB;QAClC,MAAM,GAAG,GAAG,sCAAsC,CAAC;QACnD,MAAM,YAAY,GAAqB;YACrC,MAAM,EAAE,SAAS;YACjB,IAAI,EAAE,uBAAuB;YAC7B,OAAO,EAAE,gCAAgB,CAAC,GAAG,EAAE,SAAS,CAAC;YACzC,cAAc,EAAE,kCAAkB,CAAC,GAAG,EAAE,SAAS,CAAC;SACnD,CAAC;QACF,YAAY,CAAC,QAAQ,GAAG,wDAAwD,CAAC;QACjF,KAAK,CAAC,YAAY,CAAC,CAAC;IACtB,CAAC;CACF;AAZD,sDAYC;AAED,MAAa,oBAAqB,SAAQ,uBAAS;IACjD,YAAY,MAAe;QACzB,MAAM,GAAG,GAAG,0CAA0C,CAAC;QACvD,MAAM,YAAY,GAAqB;YACrC,MAAM,EAAE,SAAS;YACjB,IAAI,EAAE,2BAA2B;YACjC,OAAO,EAAE,gCAAgB,CAAC,GAAG,CAAC,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,GAAG,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YACtE,cAAc,EAAE,kCAAkB,CAAC,GAAG,CAAC,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,GAAG,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;SAChF,CAAC;QACF,YAAY,CAAC,QAAQ,GAAG,yDAAyD,CAAC;QAClF,KAAK,CAAC,YAAY,CAAC,CAAC;IACtB,CAAC;CACF;AAZD,oDAYC;AAED,MAAa,oBAAqB,SAAQ,uBAAS;IACjD,YAAY,UAAkB,EAAE,SAAwB;QACtD,MAAM,GAAG,GAAG,qCAAqC,CAAC;QAClD,MAAM,YAAY,GAAqB;YACrC,MAAM,EAAE,SAAS;YACjB,IAAI,EAAE,sBAAsB;YAC5B,OAAO,EAAE,gCAAgB,CAAC,GAAG,EAAE,UAAU,EAAE,SAAS,CAAC;YACrD,cAAc,EAAE,kCAAkB,CAAC,GAAG,EAAE,UAAU,EAAE,SAAS,CAAC;SAC/D,CAAC;QACF,YAAY,CAAC,QAAQ,GAAG,wDAAwD,CAAC;QACjF,KAAK,CAAC,YAAY,CAAC,CAAC;IACtB,CAAC;CACF;AAZD,oDAYC"}

package/build/component/driver/botFramework/error/invalidParameterUserError.d.ts

@@ -1,5 +0,0 @@
-import { UserError } from "@microsoft/teamsfx-api";
-export declare class InvalidParameterUserError extends UserError {
-    constructor(actionName: string, invalidParameters: string | string[], helpLink: string);
-}
-//# sourceMappingURL=invalidParameterUserError.d.ts.map

package/build/component/driver/botFramework/error/invalidParameterUserError.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"invalidParameterUserError.d.ts","sourceRoot":"","sources":["../../../../../src/component/driver/botFramework/error/invalidParameterUserError.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAOnD,qBAAa,yBAA0B,SAAQ,SAAS;gBAC1C,UAAU,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,QAAQ,EAAE,MAAM;CAevF"}