Skip to content

Latest commit

 

History

History
68 lines (53 loc) · 2.34 KB

README.md

File metadata and controls

68 lines (53 loc) · 2.34 KB

Notify.Events for GitHub Action

The integration allows sending alerts and notifications from GitHub Action via 40+ messengers and other communication tools.

Receive instant messages via Slack, Signal, MS Teams, Discord, SMS, voice calls and more. Apply simple text formatting, level and priority to alerts to filter messages or distribute them among different team members / chatting apps.

See the full list of supported messengers here.

Actions Status MIT License

Read the manual in other languages

Usage

Send custom message

name: notify.events message
on: [push]
jobs:
  build:
    name: Build
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master
      - name: send custom message
        uses: notify-events/github-action@main
        with:
          token: ${{ secrets.NE_CHANNEL_TOKEN }}
          text:  This is message

Input variables

  • token - (required) Notify.Events channel token
  • title - Message title
  • text - (required) Message text (allow simple html tags: <b>, <i>, <br>, <a href="...">)
  • priority - Message priority (highest, high, normal, low, lowest)
  • level - Message level (verbose, info, notice, warning, error, success)
uses: notify-events/github-action@main
with:
  token: ${{ secrets.NE_CHANNEL_TOKEN }}
  title: Build success
  text: Build ${{ github.ref }} successfully
  priority: info
  level: success 

Predefined simple message:

  • verbose - Message text with 'verbose' level and 'lowest' priority
  • info - Message text with 'info' level and 'low' priority
  • notice - Message text with 'notice' level and 'low' priority
  • success - Message text with 'success' level and 'normal' priority
  • warning - Message text with 'warning' level and 'high' priority
  • error - Message text with 'error' level and 'highest' priority
uses: notify-events/github-action@main
with:
  token: $(( secrets.NE_CHANNEL_TOKEN }}
  success: Build {{ github.ref }} successfully