Skip to content

Commit

Permalink
fix: add debug in teams in readme (#12723)
Browse files Browse the repository at this point in the history
  • Loading branch information
@yukun-dong
yukun-dong authored Nov 14, 2024
1 parent 5152876 commit c1f95c2
Show file tree
Hide file tree
Showing 12 changed files with 78 additions and 144 deletions.
18 changes: 7 additions & 11 deletions templates/csharp/command-and-response/README.md.tpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,21 @@

## Quick Start

{{#enableTestToolByDefault}}
1. Press F5, or select Debug > Start Debugging menu in Visual Studio to start your app
2. In Teams App Test Tool from the launched browser, type and send "helloWorld" to your app to trigger a response
{{/enableTestToolByDefault}}
{{^enableTestToolByDefault}}

## Debug in Teams

1. In the debug dropdown menu, select Dev Tunnels > Create A Tunnel (set authentication type to Public) or select an existing public dev tunnel
2. Right-click your project in Solution Explorer and select Teams Toolkit > Prepare Teams App Dependencies
3. If prompted, sign in to Visual Studio with a Microsoft 365 work or school account
4. Press F5, or select Debug > Start Debugging menu in Visual Studio to start your app
5. In the opened web browser, select Add button to test the app in Teams
6. In the message input field, type and send "helloWorld" to your app to get a response
{{/enableTestToolByDefault}}
4. In Startup Item, select "Microsoft Teams (browser)"
5. Press F5, or select Debug > Start Debugging menu in Visual Studio to start your app
6. In the opened web browser, select Add button to test the app in Teams
7. In the message input field, type and send "helloWorld" to your app to get a response

> For local debugging using Teams Toolkit CLI, you need to do some extra steps described in [Set up your Teams Toolkit CLI for local debugging](https://aka.ms/teamsfx-cli-debugging).

{{^enableTestToolByDefault}}
## Debug in Test Tool
Teams App Test Tool allows developers test and debug bots locally without needing Microsoft 365 accounts, development tunnels, or Teams app and bot registration. See https://aka.ms/teams-toolkit-vs-test-tool for more details.
{{/enableTestToolByDefault}}

## Get more info

Expand Down
20 changes: 8 additions & 12 deletions templates/csharp/default-bot/README.md.tpl
View file
Original file line number Diff line number Diff line change
@@ -1,27 +1,23 @@
# Welcome to Teams Toolkit!

## Quick Start
{{#enableTestToolByDefault}}

1. Press F5, or select the Debug > Start Debugging menu in Visual Studio
2. In Teams App Test Tool from the launched browser, type and send anything to your bot to trigger a response
{{/enableTestToolByDefault}}
{{^enableTestToolByDefault}}

## Debug in Teams

1. In the debug dropdown menu, select Dev Tunnels > Create A Tunnel (set authentication type to Public) or select an existing public dev tunnel
2. Right-click your project and select Teams Toolkit > Prepare Teams App Dependencies
3. If prompted, sign in with a Microsoft 365 account for the Teams organization you want
to install the app to
4. Press F5, or select the Debug > Start Debugging menu in Visual Studio
5. In the launched browser, select the Add button to load the app in Teams
6. In the chat bar, type and send anything to your bot to trigger a response
{{/enableTestToolByDefault}}
4. In Startup Item, select "Microsoft Teams (browser)"
5. Press F5, or select the Debug > Start Debugging menu in Visual Studio
6. In the launched browser, select the Add button to load the app in Teams
7. In the chat bar, type and send anything to your bot to trigger a response

> For local debugging using Teams Toolkit CLI, you need to do some extra steps described in [Set up your Teams Toolkit CLI for local debugging](https://aka.ms/teamsfx-cli-debugging).

{{^enableTestToolByDefault}}
## Debug in Test Tool
Teams App Test Tool allows developers test and debug bots locally without needing Microsoft 365 accounts, development tunnels, or Teams app and bot registration. See https://aka.ms/teams-toolkit-vs-test-tool for more details.
{{/enableTestToolByDefault}}

## Learn more

New to Teams app development or Teams Toolkit? Learn more about
Expand Down
21 changes: 8 additions & 13 deletions templates/csharp/link-unfurling/README.md.tpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,21 @@

## Quick Start

{{#enableTestToolByDefault}}
1. Press F5 to start debugging which launches your app in Teams App Test Tool using a web browser.
2. You can unfurl links from ".botframework.com" domain.
{{/enableTestToolByDefault}}
{{^enableTestToolByDefault}}

## Debug in Teams

1. In the debug dropdown menu, select Dev Tunnels > Create A Tunnel (set authentication type to Public) or select an existing public dev tunnel
2. Right-click your project and select Teams Toolkit > Prepare Teams App Dependencies
3. If prompted, sign in with a Microsoft 365 account for the Teams organization you want
to install the app to
4. Press F5, or select the Debug > Start Debugging menu in Visual Studio
5. In the launched browser, select the Add button to load the app in Teams
6. You can unfurl links from ".botframework.com" domain.
{{/enableTestToolByDefault}}
3. If prompted, sign in with a Microsoft 365 account for the Teams organization you want to install the app to
4. In startup Item, select "Microsoft Teams (browser)"
5. Press F5, or select the Debug > Start Debugging menu in Visual Studio
6. In the launched browser, select the Add button to load the app in Teams
7. You can unfurl links from ".botframework.com" domain.

> For local debugging using Teams Toolkit CLI, you need to do some extra steps described in [Set up your Teams Toolkit CLI for local debugging](https://aka.ms/teamsfx-cli-debugging).

{{^enableTestToolByDefault}}
## Debug in Test Tool
Teams App Test Tool allows developers test and debug bots locally without needing Microsoft 365 accounts, development tunnels, or Teams app and bot registration. See https://aka.ms/teams-toolkit-vs-test-tool for more details.
{{/enableTestToolByDefault}}

## Learn more

Expand Down
18 changes: 7 additions & 11 deletions templates/csharp/message-extension-action/README.md.tpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,22 @@

## Quick Start

{{#enableTestToolByDefault}}
1. Press F5 to start debugging which launches your app in Teams App Test Tool using a web browser.
2. You can trigger "create card" command from compose message area, the command box, or directly from a message.
{{/enableTestToolByDefault}}
{{^enableTestToolByDefault}}

## Debug in Teams

1. In the debug dropdown menu, select Dev Tunnels > Create A Tunnel (set authentication type to Public) or select an existing public dev tunnel
2. Right-click your project and select Teams Toolkit > Prepare Teams App Dependencies
3. If prompted, sign in with a Microsoft 365 account for the Teams organization you want
to install the app to
4. Press F5, or select the Debug > Start Debugging menu in Visual Studio
5. In the launched browser, select the Add button to load the app in Teams
6. You can trigger "create card" command from compose message area, the command box, or directly from a message.
{{/enableTestToolByDefault}}
4. In Startup Item, select "Microsoft Teams (browser)"
5. Press F5, or select the Debug > Start Debugging menu in Visual Studio
6. In the launched browser, select the Add button to load the app in Teams
7. You can trigger "create card" command from compose message area, the command box, or directly from a message.

> For local debugging using Teams Toolkit CLI, you need to do some extra steps described in [Set up your Teams Toolkit CLI for local debugging](https://aka.ms/teamsfx-cli-debugging).

{{^enableTestToolByDefault}}
## Debug in Test Tool
Teams App Test Tool allows developers test and debug bots locally without needing Microsoft 365 accounts, development tunnels, or Teams app and bot registration. See https://aka.ms/teams-toolkit-vs-test-tool for more details.
{{/enableTestToolByDefault}}

## Learn more

Expand Down
19 changes: 7 additions & 12 deletions templates/csharp/message-extension-search/README.md.tpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,22 @@

## Quick Start

{{#enableTestToolByDefault}}
1. Press F5 to start debugging which launches your app in Teams App Test Tool using a web browser.
2. You can search nuget package from compose message area, or from the command box.
{{/enableTestToolByDefault}}
{{^enableTestToolByDefault}}

## Debug in Teams

1. In the debug dropdown menu, select Dev Tunnels > Create A Tunnel (set authentication type to Public) or select an existing public dev tunnel
2. Right-click your project and select Teams Toolkit > Prepare Teams App Dependencies
3. If prompted, sign in with a Microsoft 365 account for the Teams organization you want
to install the app to
4. Press F5, or select the Debug > Start Debugging menu in Visual Studio
5. In the launched browser, select the Add button to load the app in Teams
6. You can search nuget package from compose message area, or from the command box.
{{/enableTestToolByDefault}}
4. In Startup Item, select "Microsoft Teams (browser)"
5. Press F5, or select the Debug > Start Debugging menu in Visual Studio
6. In the launched browser, select the Add button to load the app in Teams
7. You can search nuget package from compose message area, or from the command box.

> For local debugging using Teams Toolkit CLI, you need to do some extra steps described in [Set up your Teams Toolkit CLI for local debugging](https://aka.ms/teamsfx-cli-debugging).

{{^enableTestToolByDefault}}
## Debug in Test Tool
Teams App Test Tool allows developers test and debug bots locally without needing Microsoft 365 accounts, development tunnels, or Teams app and bot registration. See https://aka.ms/teams-toolkit-vs-test-tool for more details.
{{/enableTestToolByDefault}}

## Learn more

New to Teams app development or Teams Toolkit? Learn more about
Expand Down
18 changes: 7 additions & 11 deletions templates/csharp/message-extension/README.md.tpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,22 @@

## Quick Start

{{#enableTestToolByDefault}}
1. Press F5 to start debugging which launches your app in Teams App Test Tool using a web browser.
2. You can play with this app to create an adaptive card, search for an NuGet package or unfurl links from ".botframework.com" domain.
{{/enableTestToolByDefault}}
{{^enableTestToolByDefault}}

## Debug in Teams

1. In the debug dropdown menu, select Dev Tunnels > Create A Tunnel (set authentication type to Public) or select an existing public dev tunnel
2. Right-click your project and select Teams Toolkit > Prepare Teams App Dependencies
3. If prompted, sign in with a Microsoft 365 account for the Teams organization you want
to install the app to
4. Press F5, or select the Debug > Start Debugging menu in Visual Studio
5. In the launched browser, select the Add button to load the app in Teams
6. You can play with this app to create an adaptive card, search for an NuGet package or unfurl links from ".botframework.com" domain.
{{/enableTestToolByDefault}}
4. In Startup Item, select "Microsoft Teams (browser)"
5. Press F5, or select the Debug > Start Debugging menu in Visual Studio
6. In the launched browser, select the Add button to load the app in Teams
7. You can play with this app to create an adaptive card, search for an NuGet package or unfurl links from ".botframework.com" domain.

> For local debugging using Teams Toolkit CLI, you need to do some extra steps described in [Set up your Teams Toolkit CLI for local debugging](https://aka.ms/teamsfx-cli-debugging).

{{^enableTestToolByDefault}}
## Debug in Test Tool
Teams App Test Tool allows developers test and debug bots locally without needing Microsoft 365 accounts, development tunnels, or Teams app and bot registration. See https://aka.ms/teams-toolkit-vs-test-tool for more details.
{{/enableTestToolByDefault}}

## Learn more

Expand Down
19 changes: 6 additions & 13 deletions templates/csharp/notification-http-timer-trigger-isolated/README.md.tpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,36 +2,29 @@

## Quick Start

{{#enableTestToolByDefault}}
1. Press F5, or select the Debug > Start Debugging menu in Visual Studio
2. Teams App Test Tool will be opened in the launched browser
3. [If you selected http trigger] Open Windows PowerShell and post a HTTP request to trigger
the notification(replace \<endpoint\> with real endpoint, for example localhost:5130):

Invoke-WebRequest -Uri "http://\<endpoint\>/api/notification" -Method Post

{{/enableTestToolByDefault}}
{{^enableTestToolByDefault}}
## Debug in Teams

1. In the debug dropdown menu, select Dev Tunnels > Create A Tunnel (set authentication type to Public) or select an existing public dev tunnel
2. Right-click your project and select Teams Toolkit > Prepare Teams App Dependencies
3. If prompted, sign in with a Microsoft 365 account for the Teams organization you want
to install the app to
4. Press F5, or select the Debug > Start Debugging menu in Visual Studio
5. In the launched browser, select the Add button to load the app in Teams
6. [If you selected http trigger] Open Windows PowerShell and post a HTTP request to trigger
4. In Startup Item, select "Microsoft Teams (browser)"
5. Press F5, or select the Debug > Start Debugging menu in Visual Studio
6. In the launched browser, select the Add button to load the app in Teams
7. [If you selected http trigger] Open Windows PowerShell and post a HTTP request to trigger
the notification(replace \<endpoint\> with real endpoint, for example localhost:5130):

Invoke-WebRequest -Uri "http://\<endpoint\>/api/notification" -Method Post

{{/enableTestToolByDefault}}

> For local debugging using Teams Toolkit CLI, you need to do some extra steps described in [Set up your Teams Toolkit CLI for local debugging](https://aka.ms/teamsfx-cli-debugging).

{{^enableTestToolByDefault}}
## Debug in Test Tool
Teams App Test Tool allows developers test and debug bots locally without needing Microsoft 365 accounts, development tunnels, or Teams app and bot registration. See https://aka.ms/teams-toolkit-vs-test-tool for more details.
{{/enableTestToolByDefault}}

## Learn more

New to Teams app development or Teams Toolkit? Learn more about
Expand Down
18 changes: 6 additions & 12 deletions templates/csharp/notification-http-timer-trigger/README.md.tpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,29 @@

## Quick Start

{{#enableTestToolByDefault}}
1. Press F5, or select the Debug > Start Debugging menu in Visual Studio
2. Teams App Test Tool will be opened in the launched browser
3. [If you selected http trigger] Open Windows PowerShell and post a HTTP request to trigger
the notification(replace \<endpoint\> with real endpoint, for example localhost:5130):

Invoke-WebRequest -Uri "http://\<endpoint\>/api/notification" -Method Post

{{/enableTestToolByDefault}}
{{^enableTestToolByDefault}}
## Debug in Teams

1. In the debug dropdown menu, select Dev Tunnels > Create A Tunnel (set authentication type to Public) or select an existing public dev tunnel
2. Right-click your project and select Teams Toolkit > Prepare Teams App Dependencies
3. If prompted, sign in with a Microsoft 365 account for the Teams organization you want
to install the app to
4. Press F5, or select the Debug > Start Debugging menu in Visual Studio
5. In the launched browser, select the Add button to load the app in Teams
6. [If you selected http trigger] Open Windows PowerShell and post a HTTP request to trigger
4. In Startup Item, select "Microsoft Teams (browser)"
5. Press F5, or select the Debug > Start Debugging menu in Visual Studio
6. In the launched browser, select the Add button to load the app in Teams
7. [If you selected http trigger] Open Windows PowerShell and post a HTTP request to trigger
the notification(replace \<endpoint\> with real endpoint, for example localhost:5130):

Invoke-WebRequest -Uri "http://\<endpoint\>/api/notification" -Method Post

{{/enableTestToolByDefault}}

> For local debugging using Teams Toolkit CLI, you need to do some extra steps described in [Set up your Teams Toolkit CLI for local debugging](https://aka.ms/teamsfx-cli-debugging).

{{^enableTestToolByDefault}}
## Debug in Test Tool
Teams App Test Tool allows developers test and debug bots locally without needing Microsoft 365 accounts, development tunnels, or Teams app and bot registration. See https://aka.ms/teams-toolkit-vs-test-tool for more details.
{{/enableTestToolByDefault}}

## Learn more

Expand Down
19 changes: 6 additions & 13 deletions templates/csharp/notification-http-trigger-isolated/README.md.tpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,36 +2,29 @@

## Quick Start

{{#enableTestToolByDefault}}
1. Press F5, or select the Debug > Start Debugging menu in Visual Studio
2. Teams App Test Tool will be opened in the launched browser
3. [If you selected http trigger] Open Windows PowerShell and post a HTTP request to trigger
the notification(replace \<endpoint\> with real endpoint, for example localhost:5130):

Invoke-WebRequest -Uri "http://\<endpoint\>/api/notification" -Method Post

{{/enableTestToolByDefault}}
{{^enableTestToolByDefault}}
## Debug in Teams

1. In the debug dropdown menu, select Dev Tunnels > Create A Tunnel (set authentication type to Public) or select an existing public dev tunnel
2. Right-click your project and select Teams Toolkit > Prepare Teams App Dependencies
3. If prompted, sign in with a Microsoft 365 account for the Teams organization you want
to install the app to
4. Press F5, or select the Debug > Start Debugging menu in Visual Studio
5. In the launched browser, select the Add button to load the app in Teams
6. [If you selected http trigger] Open Windows PowerShell and post a HTTP request to trigger
4. In Startup Item, select "Microsoft Teams (browser)"
5. Press F5, or select the Debug > Start Debugging menu in Visual Studio
6. In the launched browser, select the Add button to load the app in Teams
7. [If you selected http trigger] Open Windows PowerShell and post a HTTP request to trigger
the notification(replace \<endpoint\> with real endpoint, for example localhost:5130):

Invoke-WebRequest -Uri "http://\<endpoint\>/api/notification" -Method Post

{{/enableTestToolByDefault}}

> For local debugging using Teams Toolkit CLI, you need to do some extra steps described in [Set up your Teams Toolkit CLI for local debugging](https://aka.ms/teamsfx-cli-debugging).

{{^enableTestToolByDefault}}
## Debug in Test Tool
Teams App Test Tool allows developers test and debug bots locally without needing Microsoft 365 accounts, development tunnels, or Teams app and bot registration. See https://aka.ms/teams-toolkit-vs-test-tool for more details.
{{/enableTestToolByDefault}}

## Learn more

New to Teams app development or Teams Toolkit? Learn more about
Expand Down
17 changes: 6 additions & 11 deletions templates/csharp/notification-http-trigger/README.md.tpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,30 @@

## Quick Start

{{#enableTestToolByDefault}}
1. Press F5, or select the Debug > Start Debugging menu in Visual Studio
2. Teams App Test Tool will be opened in the launched browser
3. [If you selected http trigger] Open Windows PowerShell and post a HTTP request to trigger
the notification(replace \<endpoint\> with real endpoint, for example localhost:5130):

Invoke-WebRequest -Uri "http://\<endpoint\>/api/notification" -Method Post

{{/enableTestToolByDefault}}
{{^enableTestToolByDefault}}
## Debug in Teams

1. In the debug dropdown menu, select Dev Tunnels > Create A Tunnel (set authentication type to Public) or select an existing public dev tunnel
2. Right-click your project and select Teams Toolkit > Prepare Teams App Dependencies
3. If prompted, sign in with a Microsoft 365 account for the Teams organization you want
to install the app to
4. Press F5, or select the Debug > Start Debugging menu in Visual Studio
5. In the launched browser, select the Add button to load the app in Teams
6. [If you selected http trigger] Open Windows PowerShell and post a HTTP request to trigger
4. In Startup Item, select "Microsoft Teams (browser)"
5. Press F5, or select the Debug > Start Debugging menu in Visual Studio
6. In the launched browser, select the Add button to load the app in Teams
7. [If you selected http trigger] Open Windows PowerShell and post a HTTP request to trigger
the notification(replace \<endpoint\> with real endpoint, for example localhost:5130):

Invoke-WebRequest -Uri "http://\<endpoint\>/api/notification" -Method Post

{{/enableTestToolByDefault}}

> For local debugging using Teams Toolkit CLI, you need to do some extra steps described in [Set up your Teams Toolkit CLI for local debugging](https://aka.ms/teamsfx-cli-debugging).

{{^enableTestToolByDefault}}
## Debug in Test Tool
Teams App Test Tool allows developers test and debug bots locally without needing Microsoft 365 accounts, development tunnels, or Teams app and bot registration. See https://aka.ms/teams-toolkit-vs-test-tool for more details.
{{/enableTestToolByDefault}}

## Learn more

Expand Down
Loading

0 comments on commit c1f95c2

Please sign in to comment.