diff --git a/.gitignore b/.gitignore index f424f05e9..011b0882e 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,7 @@ ## Ignore Visual Studio temporary files, build results, and ## files generated by popular Visual Studio add-ons. ## -## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore +## Get latest from https://github.com/github/gitignore/blob/main/VisualStudio.gitignore # Azure Functions localsettings file local.settings.json diff --git a/.travis.yml b/.travis.yml index 99d6eb508..207b5eab4 100644 --- a/.travis.yml +++ b/.travis.yml @@ -14,7 +14,7 @@ stages: jobs: include: - stage: WikiUpdate - if: (branch = master) AND (type = push) + if: (branch = main) AND (type = push) script: - rm -rf ${REPO_SOURCE} - rm -rf ${REPO_DEST} @@ -37,5 +37,5 @@ jobs: git add . git commit -m "${REPO_SOURCE} Wiki Update | Travis CI build number $TRAVIS_BUILD_NUMBER" git remote add origin-wiki "https://${USER}:${GITHUB_TOKEN}@${GH_REPO_DEST}" - git push origin-wiki master + git push origin-wiki main fi \ No newline at end of file diff --git a/Deployment/GCC/botazuredeploy.json b/Deployment/GCC/botazuredeploy.json index 11f0b7be8..931d37cfb 100644 --- a/Deployment/GCC/botazuredeploy.json +++ b/Deployment/GCC/botazuredeploy.json @@ -44,7 +44,7 @@ "appIconUrl": { "type": "string", "minLength": 1, - "defaultValue": "https://raw.githubusercontent.com/OfficeDev/microsoft-teams-company-communicator-app/master/Manifest/color.png", + "defaultValue": "https://raw.githubusercontent.com/OfficeDev/microsoft-teams-company-communicator-app/main/Manifest/color.png", "metadata": { "description": "The link to the icon for the app. It must resolve to a PNG file." } diff --git a/Deployment/GCC/otherresourcesazuredeploy.json b/Deployment/GCC/otherresourcesazuredeploy.json index 2b7a31981..f3f5a3131 100644 --- a/Deployment/GCC/otherresourcesazuredeploy.json +++ b/Deployment/GCC/otherresourcesazuredeploy.json @@ -149,7 +149,7 @@ "metadata":{ "description":"The branch of the GitHub repository to deploy." }, - "defaultValue":"master" + "defaultValue":"main" } }, "variables":{ diff --git a/Deployment/azuredeploy.json b/Deployment/azuredeploy.json index 2dade936a..e282c73e4 100644 --- a/Deployment/azuredeploy.json +++ b/Deployment/azuredeploy.json @@ -136,7 +136,7 @@ "appIconUrl": { "type": "string", "minLength": 1, - "defaultValue": "https://raw.githubusercontent.com/OfficeDev/microsoft-teams-company-communicator-app/master/Manifest/color.png", + "defaultValue": "https://raw.githubusercontent.com/OfficeDev/microsoft-teams-company-communicator-app/main/Manifest/color.png", "metadata": { "description": "The link to the icon for the app. It must resolve to a PNG file." } @@ -193,7 +193,7 @@ "metadata": { "description": "The branch of the GitHub repository to deploy." }, - "defaultValue": "master" + "defaultValue": "main" }, "serviceBusWebAppRoleNameGuid": { "defaultValue": "958380b3-630d-4823-b933-f59d92cdcada", diff --git a/Deployment/azuredeploywithcert.json b/Deployment/azuredeploywithcert.json index a3d8fcfc2..6688db6c9 100644 --- a/Deployment/azuredeploywithcert.json +++ b/Deployment/azuredeploywithcert.json @@ -142,7 +142,7 @@ "appIconUrl": { "type": "string", "minLength": 1, - "defaultValue": "https://raw.githubusercontent.com/OfficeDev/microsoft-teams-company-communicator-app/master/Manifest/color.png", + "defaultValue": "https://raw.githubusercontent.com/OfficeDev/microsoft-teams-company-communicator-app/main/Manifest/color.png", "metadata": { "description": "The link to the icon for the app. It must resolve to a PNG file." } @@ -199,7 +199,7 @@ "metadata": { "description": "The branch of the GitHub repository to deploy." }, - "defaultValue": "master" + "defaultValue": "main" }, "serviceBusWebAppRoleNameGuid": { "defaultValue": "958380b3-630d-4823-b933-f59d92cdcada", @@ -1275,4 +1275,4 @@ "value": "[if(variables('useFrontDoor'), variables('frontDoorDomain'), concat('Please create a custom domain name for ', variables('botAppDomain'), ' and use that in the manifest'))]" } } -} +} \ No newline at end of file diff --git a/Deployment/parameters.json b/Deployment/parameters.json index 7b2f73eca..f4d301beb 100644 --- a/Deployment/parameters.json +++ b/Deployment/parameters.json @@ -112,7 +112,7 @@ "Description": "The URL to the GitHub repository to deploy." }, "gitBranch": { - "Value": "master", + "Value": "main", "Description": "The branch of the GitHub repository to deploy." }, "appDisplayName": { @@ -124,7 +124,7 @@ "Description": "The app (and bot) description." }, "appIconUrl": { - "Value": "https://raw.githubusercontent.com/OfficeDev/microsoft-teams-company-communicator-app/master/Manifest/color.png", + "Value": "https://raw.githubusercontent.com/OfficeDev/microsoft-teams-company-communicator-app/main/Manifest/color.png", "Description": "The link to the icon for the app. It must resolve to a PNG file." }, "companyName": { diff --git a/README.md b/README.md index 0fbac8957..3e0f6afbe 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ Please report bugs and other code issues [here](https://github.com/OfficeDev/mic ## Legal notice -This app template is provided under the [MIT License](https://github.com/OfficeDev/microsoft-teams-company-communicator-app/blob/master/LICENSE) terms. In addition to these terms, by using this app template you agree to the following: +This app template is provided under the [MIT License](https://github.com/OfficeDev/microsoft-teams-company-communicator-app/blob/main/LICENSE) terms. In addition to these terms, by using this app template you agree to the following: - You, not Microsoft, will license the use of your app to users or organization. diff --git a/Source/CompanyCommunicator/ClientApp/src/components/DraftMessages/draftMessages.tsx b/Source/CompanyCommunicator/ClientApp/src/components/DraftMessages/draftMessages.tsx index d2119b661..7baef35c3 100644 --- a/Source/CompanyCommunicator/ClientApp/src/components/DraftMessages/draftMessages.tsx +++ b/Source/CompanyCommunicator/ClientApp/src/components/DraftMessages/draftMessages.tsx @@ -78,6 +78,7 @@ class DraftMessages extends React.Component { }); }); this.props.getDraftMessagesList(); + // tslint:disable-next-line no-string-based-set-interval this.interval = setInterval(() => { this.props.getDraftMessagesList(); }, 60000); diff --git a/Source/CompanyCommunicator/ClientApp/src/components/Messages/messages.tsx b/Source/CompanyCommunicator/ClientApp/src/components/Messages/messages.tsx index f3b0bf1ec..a8f89df8d 100644 --- a/Source/CompanyCommunicator/ClientApp/src/components/Messages/messages.tsx +++ b/Source/CompanyCommunicator/ClientApp/src/components/Messages/messages.tsx @@ -65,6 +65,7 @@ class Messages extends React.Component { microsoftTeams.initialize(); this.props.getMessagesList(); document.addEventListener("keydown", this.escFunction, false); + // tslint:disable-next-line no-string-based-set-interval this.interval = setInterval(() => { this.props.getMessagesList(); }, 60000); diff --git a/Source/CompanyCommunicator/ClientApp/src/i18n.ts b/Source/CompanyCommunicator/ClientApp/src/i18n.ts index f2afe86a2..d54191dc7 100644 --- a/Source/CompanyCommunicator/ClientApp/src/i18n.ts +++ b/Source/CompanyCommunicator/ClientApp/src/i18n.ts @@ -12,7 +12,7 @@ export const defaultLocale = () => { } i18n - // load translation using http -> see /public/locales (i.e. https://github.com/i18next/react-i18next/tree/master/example/react/public/locales) + // load translation using http -> see /public/locales (i.e. https://github.com/i18next/react-i18next/tree/main/example/react/public/locales) // learn more: https://github.com/i18next/i18next-http-backend .use(Backend) // pass the i18n instance to react-i18next. diff --git a/Source/Test/CompanyCommunicator.Common.Test/stylecop.json b/Source/Test/CompanyCommunicator.Common.Test/stylecop.json index 2da8f83b0..eda334930 100644 --- a/Source/Test/CompanyCommunicator.Common.Test/stylecop.json +++ b/Source/Test/CompanyCommunicator.Common.Test/stylecop.json @@ -3,9 +3,9 @@ // will not take effect until additional steps are taken to enable it. See the // following page for additional information: // - // https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/EnableConfiguration.md + // https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/main/documentation/EnableConfiguration.md - "$schema": "https://raw.githubusercontent.com/DotNetAnalyzers/StyleCopAnalyzers/master/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json", + "$schema": "https://raw.githubusercontent.com/DotNetAnalyzers/StyleCopAnalyzers/main/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json", "settings": { "documentationRules": { "companyName": "Microsoft", diff --git a/Source/Test/CompanyCommunicator.Test/stylecop.json b/Source/Test/CompanyCommunicator.Test/stylecop.json index ec7abaef3..880649169 100644 --- a/Source/Test/CompanyCommunicator.Test/stylecop.json +++ b/Source/Test/CompanyCommunicator.Test/stylecop.json @@ -3,9 +3,9 @@ // will not take effect until additional steps are taken to enable it. See the // following page for additional information: // - // https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/EnableConfiguration.md + // https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/main/documentation/EnableConfiguration.md - "$schema": "https://raw.githubusercontent.com/DotNetAnalyzers/StyleCopAnalyzers/master/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json", + "$schema": "https://raw.githubusercontent.com/DotNetAnalyzers/StyleCopAnalyzers/main/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json", "settings": { "documentationRules": { "companyName": "Microsoft", diff --git a/Source/stylecop.json b/Source/stylecop.json index 2da8f83b0..eda334930 100644 --- a/Source/stylecop.json +++ b/Source/stylecop.json @@ -3,9 +3,9 @@ // will not take effect until additional steps are taken to enable it. See the // following page for additional information: // - // https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/EnableConfiguration.md + // https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/main/documentation/EnableConfiguration.md - "$schema": "https://raw.githubusercontent.com/DotNetAnalyzers/StyleCopAnalyzers/master/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json", + "$schema": "https://raw.githubusercontent.com/DotNetAnalyzers/StyleCopAnalyzers/main/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json", "settings": { "documentationRules": { "companyName": "Microsoft", diff --git a/Wiki/Deployment-guide-certificate.md b/Wiki/Deployment-guide-certificate.md index 609d04dc0..0050ec37a 100644 --- a/Wiki/Deployment-guide-certificate.md +++ b/Wiki/Deployment-guide-certificate.md @@ -81,7 +81,7 @@ Register three Azure AD application in your tenant's directory: one for author b ## 2. Deploy to your Azure subscription 1. Click on the **Deploy to Azure** button below. - [![Deploy to Azure](images/deploybutton.png)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FOfficeDev%2Fmicrosoft-teams-company-communicator-app%2Fmaster%2FDeployment%2Fazuredeploywithcert.json) + [![Deploy to Azure](images/deploybutton.png)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FOfficeDev%2Fmicrosoft-teams-company-communicator-app%2Fmain%2FDeployment%2Fazuredeploywithcert.json) 1. When prompted, log in to your Azure subscription. diff --git a/Wiki/Deployment-guide-powershell.md b/Wiki/Deployment-guide-powershell.md index 9bdb4c9c9..37b7a8606 100644 --- a/Wiki/Deployment-guide-powershell.md +++ b/Wiki/Deployment-guide-powershell.md @@ -43,7 +43,7 @@ To begin, you will need: - Open a PowerShell window in **administrator** mode and navigate to the folder where you unzipped the content. - Navigate to Deployment folder. ``` - cd microsoft-teams-apps-company-communicator-master\Deployment + cd microsoft-teams-apps-company-communicator-main\Deployment ``` - Run the below command to check if jq is installed or not. @@ -133,10 +133,10 @@ To begin, you will need: > **Note:** The default value is 2 to minimize the chances of an error during app deployment. After deployment you can choose to change the size of the hosting plan. - `gitRepoUrl` - The URL to the GitHub repository to deploy. Default value: [https://github.com/OfficeDev/microsoft-teams-company-communicator-app.git](https://github.com/OfficeDev/microsoft-teams-company-communicator-app.git) - - `gitBranch` - The branch of the GitHub repository to deploy. Default value: master + - `gitBranch` - The branch of the GitHub repository to deploy. Default value: main - `appDisplayName` - The app (and bot) display name. Default value:Company Communicator. - `appDescription` - The app (and bot) description. Default value: Broadcast messages to multiple teams and people in one go. - - `appIconUrl` - The link to the icon for the app. It must resolve to a PNG file. Default value [https://raw.githubusercontent.com/OfficeDev/microsoft-teams-company-communicator-app/master/Manifest/color.png](https://raw.githubusercontent.com/OfficeDev/microsoft-teams-company-communicator-app/master/Manifest/color.png) + - `appIconUrl` - The link to the icon for the app. It must resolve to a PNG file. Default value [https://raw.githubusercontent.com/OfficeDev/microsoft-teams-company-communicator-app/main/Manifest/color.png](https://raw.githubusercontent.com/OfficeDev/microsoft-teams-company-communicator-app/main/Manifest/color.png) - `companyName` - The display name for the company. - `websiteUrl` - The https:// URL to you company's website. This link should take users to your company or product-specific landing page. @@ -149,7 +149,7 @@ To begin, you will need: - Open a PowerShell window in **administrator** mode and navigate to Deployment folder ``` - cd microsoft-teams-apps-company-communicator-master\Deployment + cd microsoft-teams-apps-company-communicator-main\Deployment ``` - Execute the `deploy.ps1` script in the Powershell window: ``` diff --git a/Wiki/Deployment-guide.md b/Wiki/Deployment-guide.md index 244aaaeb7..1a1203bb4 100644 --- a/Wiki/Deployment-guide.md +++ b/Wiki/Deployment-guide.md @@ -90,7 +90,7 @@ Register three Azure AD application in your tenant's directory: one for author b ## 2. Deploy to your Azure subscription 1. Click on the **Deploy to Azure** button below. - [![Deploy to Azure](images/deploybutton.png)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FOfficeDev%2Fmicrosoft-teams-company-communicator-app%2Fmaster%2FDeployment%2Fazuredeploy.json) + [![Deploy to Azure](images/deploybutton.png)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FOfficeDev%2Fmicrosoft-teams-company-communicator-app%2Fmain%2FDeployment%2Fazuredeploy.json) 1. When prompted, log in to your Azure subscription. @@ -111,6 +111,7 @@ Register three Azure AD application in your tenant's directory: one for author b 1. Enter a **Base Resource Name**, which the template uses to generate names for the other resources. * The `[Base Resource Name]` must be available. For example, if you select `contosocommunicator` as the base name, the name `contosocommunicator` must be available (not taken); otherwise, the deployment will fail with a Conflict error. + * Please make sure to limit the base resource name with maximum of 18 characters. * Remember the base resource name that you selected. We will need it later. 1. Update the following fields in the template: diff --git a/Wiki/FAQ.md b/Wiki/FAQ.md index 0b3611097..3f89d1ccc 100644 --- a/Wiki/FAQ.md +++ b/Wiki/FAQ.md @@ -24,7 +24,7 @@ Yes. Bot Channels Registration only supports multi-tenant account types. Please ### 4. How to clone the GitHub repository? Please follow this [link](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) for detailed instructions on cloning GitHub repository to create a local copy on your computer and sync between the two locations. -### 5. I'm using v4.1 Company Communicator. When I resync the Company Communicator, can I set up the v4.1 branch instead of master or v4.1.x? +### 5. I'm using v4.1 Company Communicator. When I resync the Company Communicator, can I set up the v4.1 branch instead of main or v4.1.x? If you're planning to deploy version ~4, you can select the branch as v4.x but it will not point to the specific 4.1 version. Instead, it will have the highest 4.x version i.e., v4.1.5. ### 6. Can I change the app service plan without any issues? diff --git a/Wiki/Migration-guide.md b/Wiki/Migration-guide.md index b8c3db76c..ead72cab3 100644 --- a/Wiki/Migration-guide.md +++ b/Wiki/Migration-guide.md @@ -38,7 +38,7 @@ https://github.com/OfficeDev/microsoft-teams-company-communicator-app/wiki/Deplo 6. Global Administrator can also grant consent using following link: https://login.microsoftonline.com/common/adminconsent?client_id=%appId%. Please replace the `%appId%` with the `bot client id` of Microsoft Teams bot app (from above). ##### 3. Click on the "Deploy to Azure" button below -[![Deploy to Azure](images/deploybutton.png)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FOfficeDev%2Fmicrosoft-teams-company-communicator-app%2Fmaster%2FDeployment%2Fazuredeploy.json) +[![Deploy to Azure](images/deploybutton.png)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FOfficeDev%2Fmicrosoft-teams-company-communicator-app%2Fmain%2FDeployment%2Fazuredeploy.json) * When prompted, log in to the Azure subscription. > Please use the same subscription being used for your Company Communicator v1 deployment. diff --git a/Wiki/Troubleshooting.md b/Wiki/Troubleshooting.md index f79c97856..92b2b8ddb 100644 --- a/Wiki/Troubleshooting.md +++ b/Wiki/Troubleshooting.md @@ -140,7 +140,7 @@ This issue occurs when attempting multiple times node modules are installed by c 3. Once the disconnection is completed. Go to Settings and select External Git and add below URL and branch name. * Repository : https://github.com/OfficeDev/microsoft-teams-apps-company-communicator.git - * Branch : master (If you are using older version of CC, please select the branch name accordingly.) + * Branch : main (If you are using older version of CC, please select the branch name accordingly.) ![Screenshot of troubleshooting app service deployment](images/troubleshooting_appservicesyncerror_3.png) @@ -222,6 +222,20 @@ If you forgot to copy your **authorBotId**, **userBotId** and **appDomain** valu * **userBotId:** This is the user Microsoft Application ID for the Company Communicator app. It can be found in the "UserAppId" field of your configuration e.g. 5630f8a2-c2a0-4cda-bdfa-c2fa87654321. For the following steps, it will be referred to as %userBotId%. * **appDomain:** This is the base domain for the Company Communicator app. It is the value in the "AzureAd:ApplicationIdURI" field of your configuration without the "api://" e.g. appName.azurefd.net. For the following steps, it will be referred to as %appDomain%. +## 13. App service deployment fails with the error message "Input string was not in a correct format" due to fsevents package. +App Service deployment failed recently due to deprecation of package version used in the application, the issue is already fixed and released to GitHub. However, if you've performed the deployment already and wanted to fix the failed deployment, then use the below mentioned work around. + +#### Fix + +- Go to portal.azure.com. Navigate to resource group where all CC resources are deployed. +- Click on the app service -> click on Configuration +- Click on **WEBSITE_NODE_DEFAULT_VERSION.** +- Update the default value to **16.13.0** (previous value -> 10.15.2) and save. +- Click on overview and re-start the app service. +- Once the app service is restarted, navigate to Deployment Center and click on Sync. +- Wait till the deployment is completed. You can validate this once the status changes to Success under logs. # Didn't find your problem here? Please report the issue [here](https://github.com/OfficeDev/microsoft-teams-company-communicator-app/issues/new) + + diff --git a/Wiki/images/troubleshooting_sourcecontrols.png b/Wiki/images/troubleshooting_sourcecontrols.png index 4a4f453ce..5325831d9 100644 Binary files a/Wiki/images/troubleshooting_sourcecontrols.png and b/Wiki/images/troubleshooting_sourcecontrols.png differ diff --git a/Wiki/v2-migration-guide.md b/Wiki/v2-migration-guide.md index 6d7405f33..171e6a6ac 100644 --- a/Wiki/v2-migration-guide.md +++ b/Wiki/v2-migration-guide.md @@ -21,7 +21,7 @@ Please refer [step 2](https://github.com/OfficeDev/microsoft-teams-company-commu 1. Click on the **Deploy to Azure** button below. - [![Deploy to Azure](images/deploybutton.png)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FOfficeDev%2Fmicrosoft-teams-company-communicator-app%2Fmaster%2FDeployment%2Fazuredeploy.json) + [![Deploy to Azure](images/deploybutton.png)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FOfficeDev%2Fmicrosoft-teams-company-communicator-app%2Fmain%2FDeployment%2Fazuredeploy.json) 2. When prompted, log in to your Azure subscription. > Please use the same subscription being used for your Company Communicator v1 deployment (from step 1). diff --git a/Wiki/v3-migration-guide.md b/Wiki/v3-migration-guide.md index 528e4a1a2..d73ffdf8a 100644 --- a/Wiki/v3-migration-guide.md +++ b/Wiki/v3-migration-guide.md @@ -20,7 +20,7 @@ Please refer [step 2](https://github.com/OfficeDev/microsoft-teams-company-commu ### 2. Deploy to your Azure subscription 1. Click on the **Deploy to Azure** button below. - [![Deploy to Azure](images/deploybutton.png)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FOfficeDev%2Fmicrosoft-teams-company-communicator-app%2Fmaster%2FDeployment%2Fazuredeploy.json) + [![Deploy to Azure](images/deploybutton.png)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FOfficeDev%2Fmicrosoft-teams-company-communicator-app%2Fmain%2FDeployment%2Fazuredeploy.json) 2. When prompted, log in to your Azure subscription. > Please use the same subscription being used for your Company Communicator v2 deployment (from step 1). diff --git a/Wiki/v4-migration-guide.md b/Wiki/v4-migration-guide.md index c3996c76c..1c77dad79 100644 --- a/Wiki/v4-migration-guide.md +++ b/Wiki/v4-migration-guide.md @@ -90,7 +90,7 @@ Please refer [step 2](https://github.com/OfficeDev/microsoft-teams-company-commu 1. Click on the **Deploy to Azure** button below. - [![Deploy to Azure](images/deploybutton.png)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FOfficeDev%2Fmicrosoft-teams-company-communicator-app%2Fmaster%2FDeployment%2Fazuredeploy.json) + [![Deploy to Azure](images/deploybutton.png)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FOfficeDev%2Fmicrosoft-teams-company-communicator-app%2Fmain%2FDeployment%2Fazuredeploy.json) 2. When prompted, log in to your Azure subscription. > Please use the same subscription being used for your Company Communicator v3 deployment (from step 1). diff --git a/Wiki/v5-migration-guide.md b/Wiki/v5-migration-guide.md index 79a437c3f..fb1406776 100644 --- a/Wiki/v5-migration-guide.md +++ b/Wiki/v5-migration-guide.md @@ -99,7 +99,7 @@ Please refer [step 2](https://github.com/OfficeDev/microsoft-teams-company-commu ### 4. Deploy to your Azure subscription 1. Click on the **Deploy to Azure** button below. - [![Deploy to Azure](images/deploybutton.png)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FOfficeDev%2Fmicrosoft-teams-company-communicator-app%2Fmaster%2FDeployment%2Fazuredeploy.json) + [![Deploy to Azure](images/deploybutton.png)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FOfficeDev%2Fmicrosoft-teams-company-communicator-app%2Fmain%2FDeployment%2Fazuredeploy.json) 1. When prompted, log in to your Azure subscription. > Please use the same subscription being used for your Company Communicator v4 deployment (from step 1). @@ -261,5 +261,54 @@ Continuing from the Azure AD author app registration page where we ended Step 3. - Prepare link - https://login.microsoftonline.com/common/adminconsent?client_id=%appId%. Replace the `%appId%` with the `Application (client) ID` of Microsoft Graph Azure AD app (from above). - Global Administrator can grant consent using the link above. +## 7. Create the Teams app packages + +Company communicator app comes with 2 applications – Author, User. The Author application is intended for employees who create and send messages in the organization, and the User application is intended for employees who receive the messages. + +Create two Teams app packages: one to be installed to an Authors team and other for recipients to install personally and/or to teams. + +1. Make sure you have cloned the app repository locally. + +1. Open the `Manifest\manifest_authors.json` file in a text editor. + +1. Change the placeholder fields in the manifest to values appropriate for your organization. + * `developer.name` ([What's this?](https://docs.microsoft.com/en-us/microsoftteams/platform/resources/schema/manifest-schema#developer)) + * `developer.websiteUrl` + * `developer.privacyUrl` + * `developer.termsOfUseUrl` + +1. Change the `<>` placholder in the configurationUrl setting to be the `%appDomain%` value e.g. "`https://appName.azurefd.net/configtab`". + +1. Change the `<>` placeholder in the botId setting to be the `%authorBotId%` value - this is your author Azure AD application's ID from above. This is the same GUID that you entered in the template under "Author Client ID". Please note that there are two places in the manifest (for authors) where you will need to update Bot ID. + +1. Change the `<>` placeholder in the validDomains setting to be the `%appDomain%` value e.g. "`appName.azurefd.net`". + +1. Change the `<>` placeholder in the id setting of the webApplicationInfo section to be the `%authorBotId%` value. Change the `<>` placeholder in the resource setting of the webApplicationInfo section to be the `%appDomain%` value e.g. "`api://appName.azurefd.net`". + +1. Copy the `manifest_authors.json` file to a file named `manifest.json`. + +1. Create a ZIP package with the `manifest.json`,`color.png`, and `outline.png`. The two image files are the icons for your app in Teams. + * Name this package `company-communicator-authors.zip`, so you know that this is the app for the author teams. + * Make sure that the 3 files are the _top level_ of the ZIP package, with no nested folders. + ![image10](images/file-explorer.png) + +1. Delete the `manifest.json` file. + +Repeat the steps above but with the file `Manifest\manifest_users.json` and use `%userBotId%` for `<>` placeholder. Note: you will not need to change anything for the configurationUrl or webApplicationInfo section because the recipients app does not have the configurable tab. Name the resulting package `company-communicator-users.zip`, so you know that this is the app for the recipients. + +## 8. Install the lastest apps in Microsoft Teams + +1. Delete the v4.x apps and re-upload the latest v.5 manifest. Install the authors app (the `company-communicator-authors.zip` package) to your team of message authors. + * Note that even if non-authors install the app, the UPN list in the app configuration will prevent them from accessing the message authoring experience. Only the users in the sender UPN list will be able to compose and send messages. + * If your tenant has sideloading apps enabled, you can install your app by following the instructions [here](https://docs.microsoft.com/en-us/microsoftteams/platform/concepts/apps/apps-upload#load-your-package-into-teams). + +2. Add the configurable tab to the team of authors, so that they can compose and send messages. + +3. [Upload](https://docs.microsoft.com/en-us/microsoftteams/tenant-apps-catalog-teams) the User app to your tenant's app catalog so that it is available for everyone in your tenant to install. +> **IMPORTANT:** Proactive app installation will work only if you upload the User app to your tenant's app catalog. + +4. Install the User app (the `company-communicator-users.zip` package) to the users and teams that will be the target audience. +> If `proactiveAppInstallation` is enabled, you may skip this step. The service will install the app for all the recipients when authors send a message. + ### Migration Status If you have performed all the steps, migration completes after successful deployment. \ No newline at end of file