# notify-actions

**Repository Path**: jefferyjob/notify-actions

## Basic Information

- **Project Name**: notify-actions
- **Description**: 仅做同步，详情访问 GitHub。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: https://github.com/jefferyjob/notify-actions
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-10-14
- **Last Updated**: 2026-01-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Notification Actions
[English](README.en.md) | 简体中文

## 介绍
GitHub 操作可根据部署状态向各种消息平台（例如，飞书、钉钉、企业微信、ShowDoc）发送通知。

## 功能
- 支持多种通知类型。
- 允许以各种格式（文本、markdown、卡片）发送消息。
- 可用于通知部署状态，使其易于集成到 CI/CD 管道中。
- 可定制以适应不同的存储库和工作流要求。

## 示例工作流程

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

## 参数配置
| 变量名称 | 必需 | 说明                                                      |
| ------------ | -------- |---------------------------------------------------------|
| NOTICE_TYPE | 是 | 通知类型（如 `feishu`、`dingtalk`、`workWechat`、`showDoc`）。     |
| MSG_TYPE | 是 | 消息格式（如 `text`、`markdown`、`card`）。                       |
| STATUS     | 是    | 部署状态，`1` 或 `true` 表示成功，`0` 或 `false` 表示失败，用于标识本次部署是否成功。 |
| WEBHOOK_URL | 是    | 通知服务的 Webhook 地址，用于向如飞书、钉钉等平台发送部署通知。                    |

## 通知类型支持
|            | text | markdown | Card |
| ---------- | ---- | ------- | ---- |
| feishu     | √    | √       | √    |
| dingtalk   | √    | √       | ×    |
| workWechat | √    | √       | ×    |
| showDoc    | √    | ×       | ×    |

## 飞书通知示意图
**项目部署成功通知**

![success](static/success.png)

**项目部署失败通知**

![failed](static/failed.png)

## 许可证
This project is licensed under the [MIT License](LICENSE).