Skip to content

metro-digital/ms-teams-notification-action

Repository files navigation

typescript-action status

MS Teams Notification Action

A GitHub action that sends notifications to MS Teams on events specified in the workflow.

Supported events:

pull_request 
  types: [opened, reopened]
push
  branches: []
workflow_run
  types: [completed]

(The notification will be sent by default on both: success and failure conclusions.)

You can set the options workflow_run_success and workflow_run_failure to false to disable the notification. E.g. if you want to only get notifications on failures, set workflow_run_success to false.

All of the supported events can be configured in a single workflow.

Example usage:

name: notifications

on:
  pull_request:
    types: [opened, reopened]
  push:
    branches: [main]
  workflow_run:
    types: [completed]
    workflows: [my_workflow_name]

jobs:
  send:
    runs-on: ubuntu-latest
    steps:
      - name: Send pull requests to Microsoft Teams
        uses: metro-digital/ms-teams-notification-action@v1.0.3
        with:
          webhook_url: ${{ secrets.MSTEAMS_WEBHOOK_URL }}
          workflow_run_success: true # default is true
          workflow_run_failure: true # default is true

License

This project is licensed under the terms of the MIT license.

About

A GitHub action that sends notifications to MS Teams on events specified in the workflow.

Resources

License

Stars

Watchers

Forks

Packages

No packages published