Skip to content

Latest commit

 

History

History
51 lines (40 loc) · 2.21 KB

README.en.md

File metadata and controls

51 lines (40 loc) · 2.21 KB

Notification Actions

English | 简体中文

Introduction

A GitHub Action to send notifications to various messaging platforms (e.g., Feishu, DingTalk, Work WeChat, ShowDoc) based on deployment status.

Features

  • Supports multiple notification types.
  • Allows sending messages in various formats (text, markdown, card).
  • Can be used to notify about deployment statuses, making it easy to integrate into CI/CD pipelines.
  • Customizable to fit different repository and workflow requirements.

Example Workflow

- name: Send Notification
  uses: jefferyjob/notify-actions@v1
  with:
    NOTICE_TYPE: ''
    MSG_TYPE: ''
    STATUS: ''
    WEBHOOK_URL: ''

Parameter configuration

Variable name Required Description
NOTICE_TYPE Yes Notification type (such as feishu, dingtalk, workWechat, showDoc).
MSG_TYPE Yes Message format (such as text, markdown, card).
STATUS Yes Deployment status, 1 or true indicates success, 0 or false indicates failure, used to identify whether this deployment is successful.
WEBHOOK_URL Yes Webhook address of notification service, used to send deployment notifications to platforms such as Feishu and DingTalk.

Notification type support

text markdown Card
feishu
dingtalk ×
workWechat ×
showDoc × ×

Feishu notification diagram

Project deployment success notification

success

Project deployment failure notification

failed

License

This project is licensed under the MIT License.