GitHub Action
notify-microsoft-teams
v1.0.8
Latest version
Teams notify action inspired by git:homoluctus/slatify (for Slack).
This is Microsoft Teams Notification for GitHub Actions.
Generated from actions/javascript-template.
- Notify the result of GitHub Actions
- Support all job statuses (reference: job-context)
- Logs relevant jobs and steps along with their output in case of failure
- Provides flexible interface to overwrite any part of the message
- Allows sending raw json-formatted messages directly from action definition
- Allows tagging msteams member
First of all, you need to set GitHub secrets for MSTEAMS_WEBHOOK that is Incoming Webhook URL.
You can customize the following parameters:
| with parameter | required/optional | default | description |
|---|---|---|---|
| webhook_url | optional | $MSTEAMS_WEBHOOK | Microsoft Teams Incoming Webhooks URL Please specify this key or MSTEAMS_WEBHOOK environment variable |
| job | optional | {}} | JSON parsed job context |
| steps | optional | {} | JSON parsed steps context |
| needs | optional | {} | JSON parsed needs context |
| dry_run | optional | False | Do not actually send the message |
| raw | optional | '' | JSON object to send to Microsoft Teams |
| title | optional | '' | Overwrite default title |
| msteams_emails | optional | '' | Microsoft teams email ids in CSV to tag in the message |
Please refer action.yml for more details.
name: Check notification
on:
push: {}
release: {}
jobs:
success:
name: One with everything
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: Microsoft Teams Notification
uses: skitionek/notify-microsoft-teams@master
if: always()
with:
webhook_url: ${{ secrets.MSTEAMS_WEBHOOK }}
needs: ${{ toJson(needs) }}
job: ${{ toJson(job) }}
steps: ${{ toJson(steps) }}
dry_run: True
with_emails:
name: One with emails
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: MSTeams Notification
uses: ./
if: always()
with:
webhook_url: ${{ secrets.MSTEAMS_WEBHOOK }}
title: "`Overwrote title in ${workflow_link}`"
msteams_emails: "[email protected], [email protected], [email protected]"
job: ${{ toJson(job) }}
steps: ${{ toJson(steps) }}
dry_run: ${{ !github.event.action == 'release' }}
without_optional_params:
name: One with little info
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: Microsoft Teams Notification
uses: skitionek/notify-microsoft-teams@master
if: always()
with:
webhook_url: ${{ secrets.MSTEAMS_WEBHOOK }}
with_overwrite:
name: One with overwrite
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: Microsoft Teams Notification
uses: skitionek/notify-microsoft-teams@master
if: always()
with:
webhook_url: ${{ secrets.MSTEAMS_WEBHOOK }}
title: "`Overwrote title in ${workflow_link}`"
with_raw:
name: One with raw data
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: Microsoft Teams Notification
uses: skitionek/notify-microsoft-teams@master
if: always()
with:
webhook_url: ${{ secrets.MSTEAMS_WEBHOOK }}
raw: >-
{
"type": "message",
"attachments":
[
{
"contentType": "application/vnd.microsoft.card.adaptive",
"content":
{
"type": "AdaptiveCard",
"body":
[
{
"type": "TextBlock",
"text": "Test title text"
}
]
}
}
]
}
if_failure:
name: Only if failure
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: Microsoft Teams Notification
uses: skitionek/notify-microsoft-teams@master
if: failure()
with:
webhook_url: ${{ secrets.MSTEAMS_WEBHOOK }}
You are welcome to contribute in any form. I would gladly improve this package.