Github Action to Publish Workflow Notifications to Teams

Github Action to Publish Workflow Notifications to Teams

In this post, I will show you how to publish Github Workflow notifications to Microsoft Teams using a Github Action.

Pre-requisites

1. A Microsoft Teams account
2. Github Account

Steps

Create a repository on Github and clone it to your local machine.

git clone <github clone url> teams-notification-action
cd teams-notification-action

Create a new file in the repository root directory named action.yml and add the following content.

name: 'Send Teams Message'
description: 'Send messages to Teams channel via webhook using Teams cards'

inputs:
  webhook-url:
    description: 'The Teams webhook URL'
    required: true
  message-title:
    description: 'The title of the message'
    required: true
  message-text:
    description: 'The text of the message'
    required: true
  message-type:
    description: 'Give job.status as input, Should be one of failed, cancelled, or success. Default is information'
    required: false
    default: 'information' #'0076D7'
  workflow-url:
    description: 'The URL of the workflow'
    required: true

runs:
  using: 'composite'
  steps:
    - name: Set theme color
      id: theme-color
      shell: bash
      run: |
        msg_type=$(echo "$" | tr '[:upper:]' '[:lower:]')
        case "$msg_type" in
          information)
            echo "themeColor=0076D7" >> $GITHUB_OUTPUT
            ;;
          cancelled)
            echo "themeColor=FF355A" >> $GITHUB_OUTPUT
            ;;
          failure)
            echo "themeColor=FF0000" >> $GITHUB_OUTPUT
            ;;
          success)
            echo "themeColor=008000" >> $GITHUB_OUTPUT
            ;;
          *)
            echo "themeColor=0076D7" >> $GITHUB_OUTPUT
            ;;
        esac

    - name: Send message to Teams
      shell: bash
      run: |
        curl -H 'Content-Type: application/json' -d '{
          "@type": "MessageCard",
          "@context": "http://schema.org/extensions",
          "summary": "$",
          "themeColor": "$",
          "title": "$",
          "text": "$",
          "potentialAction": [
            {
              "@type": "OpenUri",
              "name": "View in GitHub",
              "targets": [
                { "os": "default", "uri": "$" }
              ]
            }
          ]
        }' $

Publish the action

Create a new file in the repository root directory named README.md and add the following content.

# Send Teams Message

This action sends a message to a Microsoft Teams channel using a webhook.

## Inputs

1. webhook-url
2. message-title
3. message-text
4. message-type
5. workflow-url

### Commit and Tag the action

```bash
git add .
git commit -m "Add action.yml"
git tag -a -m "Add action.yml" v1

git push --follow-tags

Example usage

In you current workflow file, add the following content.

uses: <username>/<repository>@<tag>
if: always()
env:
  SUCCESS_MSG: 'The workflow has completed successfully'
  FAILURE_MSG: 'The workflow has failed'
with:
  webhook-url: $
  message-title: 'Github Workflow Notification'
  # if job status is cancelled or failed then send FAILURE_MSG else send SUCCESS_MSG
  message-text:  $
  message-type: $
  workflow-url: $

You should now see the notifications in your Teams channel.

That’s it! You have successfully created a Github Action to publish notifications to Teams.