Send a Github mention to custom Teams / Flow endpoint mention

This action sends mention to a custom Teams / Flow endpoint when someone in the repo has been mentioned.

Credit

This is action is forked from and heavily based on actions-mention-to-slack by @abeyuya. Nice work!

Feature

• Send mention to endpoint if you have been mentioned
  • issue
  • pull request
• Send notification to endpoint if you have been requested to review.

Inputs

Name	Required	Default	Description
teams-webhook-url	Yes	Null	Teams/Flow custom endpoint to notify.
run-id	No	Null	Used for the link in the error message when an error occurs.

Example usage

.github/workflows/mention-to-teams.yml

on:
  issues:
    types: [opened, edited]
  issue_comment:
    types: [created, edited]
  pull_request:
    types: [opened, edited, review_requested]
  pull_request_review:
    types: [submitted]
  pull_request_review_comment:
    types: [created, edited]

jobs:
  mention-to-teams:
    runs-on: ubuntu-latest
    steps:
      - name: Run
        uses: JustSlone/actions-mention-to-teams@v1
        with:          
          teams-webhook-url: ${{ secrets.TEAMS_WEBHOOK_URL }}
          run-id: ${{ github.run_id }}     

Power Automate template

The backend for this action is written with Power Automate. Grab the Microsoft Power Automate template here and import the file on MS Power Automate: Import Package

Setting up Power Automate

1. When importing the package you'll need to login in to teams to give Power Automate permission to message teams.
2. Once you setup the Flow, copy URL from the HTTP Endpoint trigger and set it up in your Repo secrets (e.g. TEAMS_WEBHOOK_URL)
3. Then you'll need to update the GitHub to Teams mapping table (see below)

• Note when errors occur they will be posted to the gitHubUser: userForErrorNotifications add an entry for this username to get errors posted to a teams account

Development

1. install deps: $ yarn
2. build dist/index.js: $ yarn run build (Note, you'll need to build before committing so the dist files get updated)

This repo is setup to run the action within it, so you should be able to just fork and start creating issues to run the action.

I recommend using nektos/act for local testing. You'll need docker, but once you set it up you can just do:

$ export TEAMS_WEBHOOK_URL="<url from power automate>"
$ act -s TEAMS_WEBHOOK_URL -j mention-to-teams -e __tests__/issue_comment_payload.json

You will also probably want to edit issue_comment_payload.json to have your username.

Debugging

The project uses core.debug for debugging statements See More. You can display debug statements in your logs by setting the secret ACTIONS_STEP_DEBUG to true.