zcong1993-actions-ding/README.md

54 lines
2.9 KiB
Markdown
Raw Normal View History

2021-11-08 10:57:54 +08:00
# DingDing Notify Action [![Test](https://github.com/zcong1993/actions-ding/actions/workflows/test.yml/badge.svg)](https://github.com/zcong1993/actions-ding/actions/workflows/test.yml)
2019-08-26 14:36:42 +08:00
2019-08-26 15:24:49 +08:00
Send dingding simple notify message.
2019-08-26 14:36:42 +08:00
## Usage
| option | required | description |
| ----------- | -------- | ------------------------------------------------------------------------------------------------------------------- |
| dingToken | true | DingDing bot access_token |
| body | true | any kind of message body [dingding](https://ding-doc.dingtalk.com/doc#/serverapi2/qf2nxq) support into `body` field |
| secret | false | if secret set, action will call API with sign |
| ignoreError | false | if set true, will not fail action when API call failed |
## Examples
2019-08-26 15:24:49 +08:00
```yaml
- name: Send dingding notify
uses: zcong1993/actions-ding@master
with:
dingToken: ${{ secrets.DING_TOKEN }}
2019-08-29 17:50:47 +08:00
body: |
{
"msgtype": "link",
"link": {
"text": "这个即将发布的新版本,创始人陈航(花名“无招”)称它为“红树林”。而在此之前,每当面临重大升级,产品经理们都会取一个应景的代号,这一次,为什么是“红树林”?",
"title": "时代的火车向前开",
"picUrl": "",
"messageUrl": "https://www.dingtalk.com/s?__biz=MzA4NjMwMTA2Ng==&mid=2650316842&idx=1&sn=60da3ea2b29f1dcc43a7c8e4a7c97a16&scene=2&srcid=09189AnRJEdIiWVaKltFzNTw&from=timeline&isappinstalled=0&key=&ascene=2&uin=&devicetype=android-23&version=26031933&nettype=WIFI"
}
}
2019-08-26 15:24:49 +08:00
```
2019-08-29 17:50:47 +08:00
### with sign
2020-06-19 17:25:50 +08:00
```yaml
- name: Send dingding notify
uses: zcong1993/actions-ding@master
with:
dingToken: ${{ secrets.DING_TOKEN }}
2020-06-19 17:29:42 +08:00
secret: ${{ secrets.DING_SECRET }} # if secret set, action will call API with sign
2020-06-19 17:25:50 +08:00
body: |
{
"msgtype": "link",
"link": {
"text": "这个即将发布的新版本,创始人陈航(花名“无招”)称它为“红树林”。而在此之前,每当面临重大升级,产品经理们都会取一个应景的代号,这一次,为什么是“红树林”?",
"title": "时代的火车向前开",
"picUrl": "",
"messageUrl": "https://www.dingtalk.com/s?__biz=MzA4NjMwMTA2Ng==&mid=2650316842&idx=1&sn=60da3ea2b29f1dcc43a7c8e4a7c97a16&scene=2&srcid=09189AnRJEdIiWVaKltFzNTw&from=timeline&isappinstalled=0&key=&ascene=2&uin=&devicetype=android-23&version=26031933&nettype=WIFI"
}
}
```
2019-08-29 17:50:47 +08:00
put any kind of message body [dingding](https://ding-doc.dingtalk.com/doc#/serverapi2/qf2nxq) support into `body` field.