Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build: sprint release for Dec 2024 #1374

Merged
merged 23 commits into from
Dec 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
ef7709e
fix: postbuild for tab and outlook add-in sample
jayzhang Nov 12, 2024
0d0047f
feat: update large-scale-notification (#1360)
yiqing-zhao Nov 13, 2024
cb28ca7
Merge pull request #1359 from OfficeDev/huajie/fix-tab-oa
MSFT-yiz Nov 13, 2024
1e794ab
update sharenow
xzf0587 Nov 15, 2024
3111963
Merge pull request #1362 from OfficeDev/zhaofeng/sharenow/node20
xzf0587 Nov 15, 2024
8c4f02b
Merge pull request #1364 from OfficeDev/main
MSFT-yiz Nov 20, 2024
f441ccc
fix: update docker samples to use az acr build (#1365)
Yimin-Jin Nov 21, 2024
6efbc9e
update outlook sample to wxpo
hermanwenhe Nov 26, 2024
41a4cce
update launch profile
hermanwenhe Nov 26, 2024
09bec8d
rename folder
hermanwenhe Nov 26, 2024
b467536
fix
hermanwenhe Nov 26, 2024
99fc163
restore env.local
hermanwenhe Nov 26, 2024
7976e8f
update update date
hermanwenhe Nov 26, 2024
de978d0
fix CI
hermanwenhe Nov 28, 2024
3ef76d2
add back env file
hermanwenhe Nov 28, 2024
9d901be
fix: add global definition in vite config (#1368)
Yimin-Jin Nov 28, 2024
3e92d6a
fix: fix global definition in vite config (#1369)
Yimin-Jin Nov 29, 2024
66aa5fe
fix: update readme
hermanwenhe Dec 2, 2024
b856857
Merge remote-tracking branch 'upstream/dev' into dev
hermanwenhe Dec 2, 2024
8192107
Merge branch 'main' into yuqzho/dev
yuqizhou77 Dec 3, 2024
636dd05
Merge pull request #1370 from OfficeDev/yuqzho/dev
MSFT-yiz Dec 4, 2024
9bc6787
Merge branch 'OfficeDev:dev' into dev
hermanwenhe Dec 5, 2024
59cef28
Merge pull request #1366 from hermanwenhe/dev
jayzhang Dec 6, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions .config/samples-config-v3.json
Original file line number Diff line number Diff line change
Expand Up @@ -391,17 +391,18 @@
"suggested": false
},
{
"id": "hello-world-teams-tab-and-outlook-add-in",
"shortId": "helloworld-outlook",
"id": "hello-world-teams-tab-and-office-add-in",
"shortId": "helloworld-office",
"onboardDate": "2023-03-02",
"title": "Hello World Teams Tab and Outlook add-in",
"shortDescription": "A hello world project that contains both Teams Tab and Outlook add-in capability",
"fullDescription": "Microsoft Teams supports the ability to run web-based UI inside \"custom tabs\" that users can install either for just themselves (personal tabs) or within a team or group chat context. Outlook add-ins are integrations built by third parties into Outlook by using our web-based platform. Now you have the ability to create a single unit of distribution for all your Microsoft 365 extensions by using the same manifest format and schema, based on the current JSON-formatted Teams manifest.",
"title": "Hello World Teams Tab and Office add-in",
"shortDescription": "A hello world project that contains both Teams Tab and Office add-in capability",
"fullDescription": "Microsoft Teams supports the ability to run web-based UI inside \"custom tabs\" that users can install either for just themselves (personal tabs) or within a team or group chat context. Office add-ins are integrations built by third parties into Office by using our web-based platform. Now you have the ability to create a single unit of distribution for all your Microsoft 365 extensions by using the same manifest format and schema, based on the current JSON-formatted Teams manifest.",
"types": [
"Tab"
],
"tags": [
"Tab",
"Office Add-in",
"Outlook Add-in"
],
"time": "5min to run",
Expand Down
2 changes: 1 addition & 1 deletion bot-sso-docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ This sample demonstrate how to containerize a Teams App and integrate the Docker

- **Provision Infrastructure**: Automate the provisioning of Azure Container Apps and Azure Container Registry using Bicep templates. Refer to this [Azure Bicep example](./infra/azure.bicep).

- **Build and Deploy to ACA**: Build the Docker image and push it to Azure Container Registry using Docker CLI. Deploy the image to Azure Container Apps using Azure CLI. Refer to the deployment scripts in this [teamsapp.yml example](./teamsapp.yml).
- **Build and Deploy to ACA**: Using Azure CLI, build and push the Docker image to Azure Container Registry, then deploy it to Azure Container Apps. Refer to the deployment scripts in this [teamsapp.yml example](./teamsapp.yml).

## Minimal path to awesome

Expand Down
13 changes: 4 additions & 9 deletions bot-sso-docker/teamsapp.yml
Original file line number Diff line number Diff line change
Expand Up @@ -77,20 +77,15 @@ deploy:
run: echo "::set-teamsfx-env
AZURE_CONTAINER_IMAGE=${{AZURE_CONTAINER_REGISTRY_SERVER}}/sso-bot"

- uses: script
name: build container image
with:
run: docker build -t ${{AZURE_CONTAINER_IMAGE}} .

- uses: script
name: login azure container registry
with:
run: az acr login -n ${{AZURE_CONTAINER_REGISTRY_NAME}}

- uses: script
name: push container image
with:
run: docker push ${{AZURE_CONTAINER_IMAGE}}
- uses: script
name: build container image
with:
run: az acr build --registry ${{AZURE_CONTAINER_REGISTRY_NAME}} --image ${{AZURE_CONTAINER_IMAGE}} .

- uses: script
name: deploy container image
Expand Down
3 changes: 3 additions & 0 deletions hello-world-bot-with-tab/tab/vite.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ import fs from "fs";

export default defineConfig({
plugins: [react()],
define: {
global: 'globalThis',
},
server: {
port: 53000,
https: {
Expand Down
2 changes: 1 addition & 1 deletion hello-world-tab-docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ This sample demonstrate how to containerize a Teams App and integrate the Docker

- **Provision Infrastructure**: Automate the provisioning of Azure Container Apps and Azure Container Registry using Bicep templates. Refer to this [Azure Bicep example](./infra/azure.bicep).

- **Build and Deploy to ACA**: Build the Docker image and push it to Azure Container Registry using Docker CLI. Deploy the image to Azure Container Apps using Azure CLI. Refer to the deployment scripts in this [teamsapp.yml example](./teamsapp.yml).
- **Build and Deploy to ACA**: Using Azure CLI, build and push the Docker image to Azure Container Registry, then deploy it to Azure Container Apps. Refer to the deployment scripts in this [teamsapp.yml example](./teamsapp.yml).

## Minimal path to awesome

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# TeamsFx files
env/.env.*.user
env/.env.local

.DS_Store
.localConfigs
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,44 @@
{
"version": "0.2.0",
"configurations": [
{
"name": "Debug in Word Desktop (Edge Chromium)",
"type": "msedge",
"request": "attach",
"port": 9229,
"timeout": 600000,
"webRoot": "${workspaceRoot}/add-in/",
"preLaunchTask": "Start Word Add-in Locally",
"postDebugTask": "Stop Debug"
},
{
"name": "Debug in Excel Desktop (Edge Chromium)",
"type": "msedge",
"request": "attach",
"port": 9229,
"timeout": 600000,
"webRoot": "${workspaceRoot}/add-in/",
"preLaunchTask": "Start Excel Add-in Locally",
"postDebugTask": "Stop Debug"
},
{
"name": "Debug in PowerPoint Desktop (Edge Chromium)",
"type": "msedge",
"request": "attach",
"port": 9229,
"timeout": 600000,
"webRoot": "${workspaceRoot}/add-in/",
"preLaunchTask": "Start PowerPoint Add-in Locally",
"postDebugTask": "Stop Debug"
},
{
"name": "Debug in Outlook Desktop (Edge Chromium)",
"type": "msedge",
"request": "attach",
"port": 9229,
"timeout": 600000,
"webRoot": "${workspaceRoot}/add-in/",
"preLaunchTask": "Start Add-in Locally",
"preLaunchTask": "Start Outlook Add-in Locally",
"postDebugTask": "Stop Debug"
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -116,21 +116,69 @@
"showReuseMessage": false
}
},
{
"label": "Debug: Excel Desktop",
"type": "npm",
"script": "start:desktop:excel",
"options": {
"cwd": "${workspaceFolder}/add-in/"
},
"presentation": {
"clear": true,
"panel": "dedicated"
},
"problemMatcher": [],
"dependsOn": [
"Install"
]
},
{
"label": "Debug: Outlook Desktop",
"type": "npm",
"script": "start:desktop -- --app outlook",
"script": "start:desktop:outlook",
"options": {
"cwd": "${workspaceFolder}/add-in/"
},
"presentation": {
"clear": true,
"panel": "dedicated"
},
"problemMatcher": [],
"dependsOn": [
"Install"
],
]
},
{
"label": "Debug: PowerPoint Desktop",
"type": "npm",
"script": "start:desktop:powerpoint",
"options": {
"cwd": "${workspaceFolder}/add-in/"
},
"presentation": {
"clear": true,
"panel": "dedicated",
"panel": "dedicated"
},
"problemMatcher": []
"problemMatcher": [],
"dependsOn": [
"Install"
]
},
{
"label": "Debug: Word Desktop",
"type": "npm",
"script": "start:desktop:word",
"options": {
"cwd": "${workspaceFolder}/add-in/"
},
"presentation": {
"clear": true,
"panel": "dedicated"
},
"problemMatcher": [],
"dependsOn": [
"Install"
]
},
{
"label": "Dev Server",
Expand Down Expand Up @@ -209,7 +257,31 @@
"problemMatcher": []
},
{
"label": "Start Add-in Locally",
"label": "Start Word Add-in Locally",
"dependsOn": [
"Create resources",
"Debug: Word Desktop"
],
"dependsOrder": "sequence"
},
{
"label": "Start Excel Add-in Locally",
"dependsOn": [
"Create resources",
"Debug: Excel Desktop"
],
"dependsOrder": "sequence"
},
{
"label": "Start PowerPoint Add-in Locally",
"dependsOn": [
"Create resources",
"Debug: PowerPoint Desktop"
],
"dependsOrder": "sequence"
},
{
"label": "Start Outlook Add-in Locally",
"dependsOn": [
"Create resources",
"Debug: Outlook Desktop"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,28 +5,28 @@ languages:
products:
- office-teams
- office
name: Hello World Teams Tab and Outlook add-in
urlFragment: officedev-teamsfx-samples-tab-hello-world-teams-tab-and-outlook-add-in
description: A hello world project that contains both Teams Tab and Outlook add-in capability.
name: Hello World Teams Tab and Office add-in
urlFragment: officedev-teamsfx-samples-tab-hello-world-teams-tab-and-office-add-in
description: A hello world project that contains both Teams Tab and Office add-in capability.
extensions:
createdDate: "2023-03-02"
---
# Getting Started with Hello World Teams Tab and Outlook add-in Sample
# Getting Started with Hello World Teams Tab and Office add-in Sample

Microsoft Teams supports the ability to run web-based UI inside "custom tabs" that users can install either for just themselves (personal tabs) or within a team or group chat context.

Outlook add-ins are integrations built by third parties into Outlook by using our web-based platform.
Office add-ins are integrations built by third parties into Office by using our web-based platform.

Now you have the ability to create a single unit of distribution for all your Microsoft 365 extensions by using the same manifest format and schema, based on the current JSON-formatted Teams manifest.

## This sample illustrates

- How a Teams Tab and an Outlook add-in share the same JSON manifest in one project.
- How a Teams Tab and an Office add-in share the same JSON manifest in one project.

## Prerequisites to use this sample

- [Node.js](https://nodejs.org/), supported versions: 16, 18
- Edge or Chrome installed for debugging Teams Tab. Edge installed for debugging Outlook add-in.
- [Node.js](https://nodejs.org/), supported versions: 18, 20
- Edge or Chrome installed for debugging Teams Tab. Edge installed for debugging Office add-in.
- Outlook for Windows: Beta Channel, Build 16320 or higher. Follow [this link](https://github.com/OfficeDev/TeamsFx/wiki/How-to-switch-Outlook-client-update-channel-and-verify-Outlook-client-build-version) for information about how to update channels and check your Outlook client build version.
- An M365 account. If you do not have M365 account, apply one from [M365 developer program](https://developer.microsoft.com/en-us/microsoft-365/dev-program)
- [Teams Toolkit Visual Studio Code Extension](https://aka.ms/teams-toolkit) version 5.0.0 and higher or [Teams Toolkit CLI](https://aka.ms/teams-toolkit-cli)
Expand All @@ -43,19 +43,21 @@ Now you have the ability to create a single unit of distribution for all your Mi
After installing the app in Teams when prompted, it will launch and you'll be able to view the tab app.
![Sample tab app running in Teams](./images/teams-tab-app.PNG)

### Debug Outlook add-in
### Debug Office add-in

- Please note that the same M365 account should be used both in Teams Toolkit and Outlook.
- Please note that the same M365 account should be used both in Teams Toolkit and Office Applications (Word, Exce, Powerpoint, Outlook).
- From Visual Studio Code only: use the `Run and Debug Activity Panel` in Visual Studio Code, select `Debug in Outlook Desktop (Edge Chromium)`, and click the `Run and Debug` green arrow button. Please run VSCode as administrator if localhost loopback for Microsoft Edge Webview hasn't been enabled. Once enbaled, administrator priviledge is no longer required.

![Visual Studio Code debug configuration for Outlook](./images/outlook-debug.PNG)
![Visual Studio Code debug configuration for Office](./images/outlook-debug.PNG)

Once the Outlook app is open, select a mailbox item, and you can then use the Outlook add-in. For example, you can select the option to show a task pane.
![Outlook add-in show taskpane](./images/outlook-addin-open.PNG)

The taskpane should look as shown in the following image.
![Outook add-in task pane opened](./images/outlook-addin-taskpane.PNG)

Other Office Applications share the same behavior.

### Edit the manifest

You can find the app manifest in `./appPackage` folder. The folder contains one manifest file:
Expand Down Expand Up @@ -86,9 +88,9 @@ Once the provisioning and deployment steps are finished, you can preview your Te

- From Teams Toolkit CLI: execute `teamsapp preview --env dev` in your project directory to launch your application.

### Preview Outlook add-in
### Preview Office add-in

Once the provisioning and deployment steps are finished, you can preview your Outlook add-in from Visual Studio Code:
Once the provisioning and deployment steps are finished, you can preview your Office add-in from Visual Studio Code:

1. Copy the production URL from the `TAB_ENDPOINT` in env/.env.dev file.
2. Edit webpack.config.js file and change urlProd to the value you just copied. Please note to add a '/' at the end of the URL.
Expand Down Expand Up @@ -116,6 +118,7 @@ To check that your manifest file is valid:
|April 11, 2023 | yufuwang | comment out manifest validation |
|May 24, 2023 | yefuwang | update outdated content |
|September 10, 2023 | joshuapa | added images |
|Nov 29, 2024 | hermanwen | replace outlook with office capability |

## Feedback

Expand Down
69 changes: 69 additions & 0 deletions hello-world-teams-tab-and-office-add-in/add-in/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
{
"name": "office-addin-taskpane",
"version": "0.0.1",
"repository": {
"type": "git",
"url": "https://github.com/OfficeDev/Office-Addin-TaskPane.git"
},
"license": "MIT",
"config": {
"app_to_debug": "excel",
"app_type_to_debug": "desktop",
"dev_server_port": 53000
},
"scripts": {
"build": "webpack --mode production",
"build:dev": "webpack --mode development",
"dev-server": "webpack serve --mode development",
"lint": "office-addin-lint check",
"lint:fix": "office-addin-lint fix",
"prettier": "office-addin-lint prettier",
"signin": "office-addin-dev-settings m365-account login",
"signout": "office-addin-dev-settings m365-account logout",
"start": "office-addin-debugging start ../appPackage/build/appPackage.local.zip",
"start:desktop": "office-addin-debugging start ../appPackage/build/appPackage.local.zip desktop",
"start:desktop:word": "office-addin-debugging start ../appPackage/build/appPackage.local.zip --app word",
"start:desktop:excel": "office-addin-debugging start ../appPackage/build/appPackage.local.zip --app excel",
"start:desktop:powerpoint": "office-addin-debugging start ../appPackage/build/appPackage.local.zip --app powerpoint",
"start:desktop:outlook": "office-addin-debugging start ../appPackage/build/appPackage.local.zip --app outlook",
"start:web": "office-addin-debugging start ../appPackage/build/appPackage.local.zip web",
"stop": "office-addin-debugging stop ../appPackage/build/manifest.local.json",
"validate": "office-addin-manifest validate ../appPackage/build/manifest.local.json",
"watch": "webpack --mode development --watch"
},
"dependencies": {
"core-js": "^3.36.0",
"regenerator-runtime": "^0.14.1"
},
"devDependencies": {
"@babel/core": "^7.24.0",
"@babel/preset-typescript": "^7.23.3",
"@types/office-js": "^1.0.377",
"@types/office-runtime": "^1.0.35",
"babel-loader": "^9.1.3",
"copy-webpack-plugin": "^12.0.2",
"eslint-plugin-office-addins": "^3.0.2",
"file-loader": "^6.2.0",
"html-loader": "^5.0.0",
"html-webpack-plugin": "^5.6.0",
"office-addin-cli": "^1.6.3",
"office-addin-debugging": "^5.1.4",
"office-addin-dev-certs": "^1.13.3",
"office-addin-lint": "^2.3.3",
"office-addin-manifest": "^1.13.4",
"office-addin-prettier-config": "^1.2.1",
"os-browserify": "^0.3.0",
"process": "^0.11.10",
"source-map-loader": "^5.0.0",
"ts-loader": "^9.5.1",
"typescript": "^5.4.2",
"webpack": "^5.90.3",
"webpack-cli": "^5.1.4",
"webpack-dev-server": "5.0.3"
},
"prettier": "office-addin-prettier-config",
"browserslist": [
"last 2 versions",
"ie 11"
]
}
Loading
Loading