Skip to content

Commit

Permalink
added manifest changes for nodejs samples
Browse files Browse the repository at this point in the history
  • Loading branch information
Prithvi-MSFT committed Sep 6, 2023
1 parent 035a896 commit cb945b4
Show file tree
Hide file tree
Showing 157 changed files with 229 additions and 305 deletions.
6 changes: 3 additions & 3 deletions samples/incoming-webhook/nodejs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,11 +86,11 @@ This sample demos UI to type in Incoming Webhook URL and message card payload, w

### 4. Setup Manifest for Teams
1) __*This step is specific to Teams.*__
- **Edit** the `manifest.json` contained in the `AppPackage` folder to replace `{{Manifest-id}}` with any `GUID` ID.
- **Edit** the `manifest.json` contained in the `appManifest` folder to replace `{{Manifest-id}}` with any `GUID` ID.
- **Edit** the `manifest.json` for `contentUrl`, `websiteUrl` inside `staticTabs` section. Replace `<<Domain-name>>` with app's base Url domain. E.g. if you are using ngrok it would be `https://1234.ngrok-free.app` then your domain-name will be `1234.ngrok-free.app` and if you are using dev tunnels then your domain will be like: `12345.devtunnels.ms`.
- **Edit** the `manifest.json` for `validDomains` with base Url domain. E.g. if you are using ngrok it would be `https://1234.ngrok-free.app` then your domain-name will be `1234.ngrok-free.app` and if you are using dev tunnels then your domain will be like: `12345.devtunnels.ms`.
- **Note:** If you want to test your app across multi hub like: Outlook/Office.com, please update the `manifest.json` in the `incoming-webhook\nodejs\Manifest_Hub` folder with the required values.
- **Zip** up the contents of the `AppPackage` folder to create a `Manifest.zip` or `Manifest_Hub` folder to create a `Manifest_Hub.zip`(Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)
- **Note:** If you want to test your app across multi hub like: Outlook/Office.com, please update the `manifest.json` in the `incoming-webhook\nodejs\appManifest_Hub` folder with the required values.
- **Zip** up the contents of the `appManifest` folder to create a `Manifest.zip` or `appManifest_Hub` folder to create a `appManifest_Hub.zip`(Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)
- **Upload** the `manifest.zip` to Teams (In Teams Apps/Manage your apps click "Upload an app". Browse to and Open the .zip file. At the next dialog, click the Add button.)
- Add the app to personal scope.
Expand Down
2 changes: 1 addition & 1 deletion samples/meeting-recruitment-app/nodejs/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ yarn-error.log*
env/.env.*.user
env/.env.local
.localConfigs
appPackage/build
appMAnifest/build
/build

# dependencies
Expand Down
6 changes: 3 additions & 3 deletions samples/meeting-recruitment-app/nodejs/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,14 +127,14 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual

6. Setup Manifest for Teams
- __*This step is specific to Teams.*__
- **Edit** the `manifest.json` contained in the ./AppPackage folder to replace your Microsoft App Id (that was created when you registered your app registration earlier) *everywhere* you see the place holder string `<<APP-ID>>` (depending on the scenario the Microsoft App Id may occur multiple times in the `manifest.json`)
- **Edit** the `manifest.json` contained in the ./appManifest folder to replace your Microsoft App Id (that was created when you registered your app registration earlier) *everywhere* you see the place holder string `<<APP-ID>>` (depending on the scenario the Microsoft App Id may occur multiple times in the `manifest.json`)
- **Edit** the `manifest.json` for `<<BASE-URL>>` and replace `<<BASE-URL>>` with base Url of your domain. E.g. if you are using ngrok it would be `https://1234.ngrok-free.app` then your domain-name will be `1234.ngrok-free.app` and if you are using dev tunnels then your domain will be like: `12345.devtunnels.ms`.
- **Zip** up the contents of the `AppPackage` folder to create a `manifest.zip` (Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)
- **Zip** up the contents of the `appManifest` folder to create a `manifest.zip` (Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)
- Upload the manifest.zip to Teams (in the Apps view click "Upload a custom app")
- Go to Microsoft Teams. From the lower left corner, select Apps
- From the lower left corner, choose Upload a custom App
- Go to your project directory, the ./AppPackage folder, select the zip folder, and choose Open.
- Go to your project directory, the ./appManifest folder, select the zip folder, and choose Open.
- Select Add in the pop-up dialog box. Your app is uploaded to Teams.
**Note**: If you are facing any issue in your app, please uncomment [this](https://github.com/OfficeDev/Microsoft-Teams-Samples/blob/main/samples/meeting-recruitment-app/nodejs/api/server/index.js#L55) line and put your debugger for local debug.
Expand Down
2 changes: 1 addition & 1 deletion samples/meeting-recruitment-app/nodejs/api/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"build": "node build.js",
"lint": "eslint .",
"server": "npm install && node server/index.js",
"manifest": "del \"appPackage\\appPackage.zip\" 2> nul && powershell Compress-Archive appPackage/* appPackage/appPackage.zip"
"manifest": "del \"appManifest\\appManifest.zip\" 2> nul && powershell Compress-Archive appManifest/* appManifest/appManifest.zip"
},
"keywords": [],
"author": "Microsoft",
Expand Down
12 changes: 6 additions & 6 deletions samples/meeting-recruitment-app/nodejs/teamsapp.local.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,28 +48,28 @@ provision:
- uses: teamsApp/validateManifest
with:
# Path to manifest template
manifestPath: ./appPackage/manifest.json
manifestPath: ./appManifest/manifest.json

# Build Teams app package with latest env value
- uses: teamsApp/zipAppPackage
with:
# Path to manifest template
manifestPath: ./appPackage/manifest.json
outputZipPath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
outputJsonPath: ./appPackage/build/manifest.${{TEAMSFX_ENV}}.json
manifestPath: ./appManifest/manifest.json
outputZipPath: ./appManifest/build/appManifest.${{TEAMSFX_ENV}}.zip
outputJsonPath: ./appManifest/build/manifest.${{TEAMSFX_ENV}}.json
# Validate app package using validation rules
- uses: teamsApp/validateAppPackage
with:
# Relative path to this file. This is the path for built zip file.
appPackagePath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
appPackagePath: ./appManifest/build/appManifest.${{TEAMSFX_ENV}}.zip

# 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.
- uses: teamsApp/update
with:
# Relative path to this file. This is the path for built zip file.
appPackagePath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
appPackagePath: ./appManifest/build/appManifest.${{TEAMSFX_ENV}}.zip

deploy:
# Run npm command
Expand Down
2 changes: 1 addition & 1 deletion samples/meeting-tabs/nodejs/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ yarn-error.log*
env/.env.*.user
env/.env.local
.localConfigs
appPackage/build
appManifest/build
/build

# dependencies
Expand Down
4 changes: 2 additions & 2 deletions samples/meeting-tabs/nodejs/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,11 +107,11 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual

8. __*This step is specific to Teams.*__

- **Edit** the `manifest.json` contained in the `teamsAppManifest` folder to replace your Microsoft App Id (that was created when you registered your bot earlier) *everywhere* you see the place holder string `<<YOUR-MICROSOFT-APP-ID>>` (depending on the scenario the Microsoft App Id may occur multiple times in the `manifest.json`)
- **Edit** the `manifest.json` contained in the `appManifest` folder to replace your Microsoft App Id (that was created when you registered your bot earlier) *everywhere* you see the place holder string `<<YOUR-MICROSOFT-APP-ID>>` (depending on the scenario the Microsoft App Id may occur multiple times in the `manifest.json`)
- **Edit** the `manifest.json` for `<<DOMAIN-NAME>>` with base Url domain. E.g. if you are using ngrok it would be `https://1234.ngrok-free.app` then your domain-name will be `1234.ngrok-free.app` and if you are using dev tunnels then your domain will be like: `12345.devtunnels.ms`.
- **Zip** up the contents of the `teamsAppManifest` folder to create a `manifest.zip` (Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)
- **Zip** up the contents of the `appManifest` folder to create a `manifest.zip` (Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)
- **Upload** the `manifest.zip` to Teams (In Teams Apps/Manage your apps click "Upload an app". Browse to and Open the .zip file. At the next dialog, click the Add button.)
Expand Down
14 changes: 7 additions & 7 deletions samples/meeting-tabs/nodejs/teamsapp.local.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,32 +24,32 @@ provision:
- uses: teamsApp/validateManifest
with:
# Path to manifest template
manifestPath: ./appPackage/manifest.json
manifestPath: ./appManifest/manifest.json

# Build Teams app package with latest env value
- uses: teamsApp/zipAppPackage
with:
# Path to manifest template
manifestPath: ./appPackage/manifest.json
outputZipPath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
outputJsonPath: ./appPackage/build/manifest.${{TEAMSFX_ENV}}.json
manifestPath: ./appManifest/manifest.json
outputZipPath: ./appManifest/build/appManifest.${{TEAMSFX_ENV}}.zip
outputJsonPath: ./appManifest/build/manifest.${{TEAMSFX_ENV}}.json
# Validate app package using validation rules
- uses: teamsApp/validateAppPackage
with:
# Relative path to this file. This is the path for built zip file.
appPackagePath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
appPackagePath: ./appManifest/build/appManifest.${{TEAMSFX_ENV}}.zip
# 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.
- uses: teamsApp/update
with:
# Relative path to this file. This is the path for built zip file.
appPackagePath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
appPackagePath: ./appManifest/build/appManifest.${{TEAMSFX_ENV}}.zip
# Extend your Teams app to Outlook and the Microsoft 365 app
- uses: teamsApp/extendToM365
with:
# Relative path to the build app package.
appPackagePath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
appPackagePath: ./appManifest/build/appManifest.${{TEAMSFX_ENV}}.zip
# Write the information of created resources into environment file for
# the specified environment variable(s).
writeToEnvironmentFile:
Expand Down
2 changes: 1 addition & 1 deletion samples/meetings-app-icon-badging/nodejs/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
env/.env.*.user
env/.env.local
.localConfigs
appPackage/build
appManifest/build
/build

# dependencies
Expand Down
6 changes: 3 additions & 3 deletions samples/meetings-app-icon-badging/nodejs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,13 +113,13 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual
4) Setup Manifest for Teams
- Modify the `manifest.json` file placed in `/appPackage` folder and replace the <<YOUR-MICROSOFT-APP-ID>> with your Microsoft App Id received via doing AAD app registration in your Azure Portal.
- Modify the `manifest.json` file placed in `/appManifest` folder and replace the <<YOUR-MICROSOFT-APP-ID>> with your Microsoft App Id received via doing AAD app registration in your Azure Portal.
- **Edit** the `manifest.json` for `validDomains` and replace <<Valid-Domain>> with base Url domain. E.g. if you are using ngrok it would be `https://1234.ngrok-free.app` then your domain-name will be `1234.ngrok-free.app` and if you are using dev tunnels then your domain will be like: `12345.devtunnels.ms`.
- **Zip** up the contents of the `appPackage` folder to create a `manifest.zip`
- **Zip** up the contents of the `appManifest` folder to create a `manifest.zip`
- - **Upload** the `manifest.zip` to Teams
- Select **Apps** from the left panel.
- Then select **Upload a custom app** from the lower right corner.
- Then select the `manifest.zip` file from `appPackage`.
- Then select the `manifest.zip` file from `appManifest`.
- [Install the App in Teams Meeting](https://docs.microsoft.com/microsoftteams/platform/apps-in-teams-meetings/teams-apps-in-meetings?view=msteams-client-js-latest#meeting-lifecycle-scenarios)
**Note**: If you are facing any issue in your app, please uncomment [this](https://github.com/OfficeDev/Microsoft-Teams-Samples/blob/main/samples/meetings-app-icon-badging/nodejs/index.js#L45) line and put your debugger for local debug.
Expand Down
12 changes: 6 additions & 6 deletions samples/meetings-app-icon-badging/nodejs/teamsapp.local.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,28 +48,28 @@ provision:
- uses: teamsApp/validateManifest
with:
# Path to manifest template
manifestPath: ./appPackage/manifest.json
manifestPath: ./appPacappManifestkage/manifest.json

# Build Teams app package with latest env value
- uses: teamsApp/zipAppPackage
with:
# Path to manifest template
manifestPath: ./appPackage/manifest.json
outputZipPath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
outputJsonPath: ./appPackage/build/manifest.${{TEAMSFX_ENV}}.json
manifestPath: ./appManifest/manifest.json
outputZipPath: ./appManifest/build/appManifest.${{TEAMSFX_ENV}}.zip
outputJsonPath: ./appManifest/build/manifest.${{TEAMSFX_ENV}}.json
# Validate app package using validation rules
- uses: teamsApp/validateAppPackage
with:
# Relative path to this file. This is the path for built zip file.
appPackagePath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
appPackagePath: ./appManifest/build/appManifest.${{TEAMSFX_ENV}}.zip

# 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.
- uses: teamsApp/update
with:
# Relative path to this file. This is the path for built zip file.
appPackagePath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
appPackagePath: ./appManifest/build/appManifest.${{TEAMSFX_ENV}}.zip

deploy:
# Run npm command
Expand Down
2 changes: 1 addition & 1 deletion samples/meetings-attendance-report/nodejs/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ yarn-error.log*
env/.env.*.user
env/.env.local
.localConfigs
appPackage/build
appManifest/build
/build

# dependencies
Expand Down
6 changes: 3 additions & 3 deletions samples/meetings-attendance-report/nodejs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,14 +143,14 @@ Make sure you've downloaded and installed Ngrok on your local machine. ngrok wil

6. Setup Manifest for Teams
- __*This step is specific to Teams.*__
- **Edit** the `manifest.json` contained in the ./AppPackage folder to replace your Microsoft App Id (that was created when you registered your app registration earlier) *everywhere* you see the place holder string `{{Microsoft-App-Id}}` (depending on the scenario the Microsoft App Id may occur multiple times in the `manifest.json`)
- **Edit** the `manifest.json` contained in the ./appManifest folder to replace your Microsoft App Id (that was created when you registered your app registration earlier) *everywhere* you see the place holder string `{{Microsoft-App-Id}}` (depending on the scenario the Microsoft App Id may occur multiple times in the `manifest.json`)
- **Edit** the `manifest.json` for `validDomains` and replace `{{domain-name}}` with base Url of your domain. E.g. if you are using ngrok it would be `https://1234.ngrok-free.app` then your domain-name will be `1234.ngrok-free.app` and if you are using dev tunnels then your domain will be like: `12345.devtunnels.ms`.
- **Zip** up the contents of the `AppPackage` folder to create a `manifest.zip` (Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)
- **Zip** up the contents of the `appManifest` folder to create a `manifest.zip` (Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)

- Upload the manifest.zip to Teams (in the Apps view click "Upload a custom app")
- Go to Microsoft Teams. From the lower left corner, select Apps
- From the lower left corner, choose Upload a custom App
- Go to your project directory, the ./AppPackage folder, select the zip folder, and choose Open.
- Go to your project directory, the ./appManifest folder, select the zip folder, and choose Open.
- Select Add in the pop-up dialog box. Your app is uploaded to Teams.

**Note**: If you are facing any issue in your app, please uncomment [this](https://github.com/OfficeDev/Microsoft-Teams-Samples/blob/main/samples/meetings-attendance-report/nodejs/index.js#L52) line and put your debugger for local debug.
Expand Down
12 changes: 6 additions & 6 deletions samples/meetings-attendance-report/nodejs/teamsapp.local.yml
Original file line number Diff line number Diff line change
Expand Up @@ -52,28 +52,28 @@ provision:
- uses: teamsApp/validateManifest
with:
# Path to manifest template
manifestPath: ./appPackage/manifest.json
manifestPath: ./appManifest/manifest.json

# Build Teams app package with latest env value
- uses: teamsApp/zipAppPackage
with:
# Path to manifest template
manifestPath: ./appPackage/manifest.json
outputZipPath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
outputJsonPath: ./appPackage/build/manifest.${{TEAMSFX_ENV}}.json
manifestPath: ./appManifest/manifest.json
outputZipPath: ./appManifest/build/appManifest.${{TEAMSFX_ENV}}.zip
outputJsonPath: ./appManifest/build/manifest.${{TEAMSFX_ENV}}.json
# Validate app package using validation rules
- uses: teamsApp/validateAppPackage
with:
# Relative path to this file. This is the path for built zip file.
appPackagePath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
appPackagePath: ./appManifest/build/appManifest.${{TEAMSFX_ENV}}.zip

# 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.
- uses: teamsApp/update
with:
# Relative path to teamsfx folder. This is the path for built zip file.
appPackagePath: ./appPackage/build/appPackage.${{TEAMSFX_ENV}}.zip
appPackagePath: ./appManifest/build/appManifest.${{TEAMSFX_ENV}}.zip

deploy:
# Run npm command
Expand Down
2 changes: 1 addition & 1 deletion samples/meetings-audio-state/nodejs/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ yarn-error.log*
env/.env.*.user
env/.env.local
.localConfigs
appPackage/build
appManifest/build
/build

# dependencies
Expand Down
4 changes: 2 additions & 2 deletions samples/meetings-audio-state/nodejs/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,11 +96,11 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual

8. __*This step is specific to Teams.*__

- **Edit** the `manifest.json` contained in the `TeamsAppManifest` folder to replace your Microsoft App Id (that was created when you registered your bot earlier) *everywhere* you see the place holder string `<<YOUR-MICROSOFT-APP-ID>>` (depending on the scenario the Microsoft App Id may occur multiple times in the `manifest.json`)
- **Edit** the `manifest.json` contained in the `appManifest` folder to replace your Microsoft App Id (that was created when you registered your bot earlier) *everywhere* you see the place holder string `<<YOUR-MICROSOFT-APP-ID>>` (depending on the scenario the Microsoft App Id may occur multiple times in the `manifest.json`)
- **Edit** the `manifest.json` for `<<DOMAIN-NAME>>` with base Url domain. E.g. if you are using ngrok it would be `https://1234.ngrok-free.app` then your domain-name will be `1234.ngrok-free.app` and if you are using dev tunnels then your domain will be like: `12345.devtunnels.ms`.
- **Zip** up the contents of the `TeamsAppManifest` folder to create a `manifest.zip` (Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)
- **Zip** up the contents of the `appManifest` folder to create a `manifest.zip` (Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)
- **Upload** the `manifest.zip` to Teams (In Teams Apps/Manage your apps click "Upload an app". Browse to and Open the .zip file. At the next dialog, click the Add button.)
Expand Down
Loading

0 comments on commit cb945b4

Please sign in to comment.