Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jefferyjob/notify-actions
用于发送消息通知的 GitHub Actions 工具。GitHub Actions tool for sending message notifications.
https://github.com/jefferyjob/notify-actions
actions notice notify
Last synced: 18 days ago
JSON representation
用于发送消息通知的 GitHub Actions 工具。GitHub Actions tool for sending message notifications.
- Host: GitHub
- URL: https://github.com/jefferyjob/notify-actions
- Owner: jefferyjob
- License: mit
- Created: 2024-10-12T08:43:09.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-10-16T06:50:04.000Z (29 days ago)
- Last Synced: 2024-10-18T00:36:04.070Z (28 days ago)
- Topics: actions, notice, notify
- Language: Shell
- Homepage: https://github.com/marketplace/actions/notification-action
- Size: 22.5 KB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.en.md
- License: LICENSE
Awesome Lists containing this project
README
# Notification Actions
English | [简体中文](README.md)
## 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
```yaml
- 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 | √ | × | × |
## License
This project is licensed under the [MIT License](LICENSE).