diff --git a/README.md b/README.md index 64b1f17..7ef5b27 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,20 @@ 企业微信机器人Jenkins插件 ### Quick start -- 必要的配置 - - 配置企业微信机器人:需要在 jenkins 系统配置中配置企业微信机器人,支持配置多个机器人 - - 配置用户的手机号码:需要在 jenkins 用户信息页面,配置企业微信成员手机号码,用于在企业微信中 @ 成员 +- 必要的配置 + - 配置说明:[参考文档](docs/settings.md) + +- 调用说明 + - 函数:wxwork() + - 参数: + - robot:字符串,机器人ID,在 jenkins 系统配置中配置的企业微信机器人ID + - type:字符串,企业微信消息类型(text - 文本消息 / markdown - Markdown格式消息 / image - 图片消息) + - atMe:Boolean,消息是否"@"我自己(当前构建任务执行人) + - atAll:Boolean,消息是否"@"所有人 + - at:Array:需要被"@"到的人的企业微信成员手机号列表 + - text:Array:消息内容数组 + - imageUrl:字符串,当前项目图片文件的相对路径(只有`type`为`image`时有效) + - Jenkinsfile (脚本写法) diff --git a/docs/images/stage1-1.png b/docs/images/stage1-1.png new file mode 100644 index 0000000..93f78fc Binary files /dev/null and b/docs/images/stage1-1.png differ diff --git a/docs/images/stage1-2.png b/docs/images/stage1-2.png new file mode 100644 index 0000000..2f9909e Binary files /dev/null and b/docs/images/stage1-2.png differ diff --git a/docs/images/stage1-3.png b/docs/images/stage1-3.png new file mode 100644 index 0000000..6c5ac01 Binary files /dev/null and b/docs/images/stage1-3.png differ diff --git a/docs/images/stage1-4.png b/docs/images/stage1-4.png new file mode 100644 index 0000000..50eb91d Binary files /dev/null and b/docs/images/stage1-4.png differ diff --git a/docs/images/stage2-1.png b/docs/images/stage2-1.png new file mode 100644 index 0000000..71806b3 Binary files /dev/null and b/docs/images/stage2-1.png differ diff --git a/docs/settings.md b/docs/settings.md new file mode 100644 index 0000000..9feccd0 --- /dev/null +++ b/docs/settings.md @@ -0,0 +1,31 @@ +# 企业微信机器人配置 + +### 一、配置企业微信机器人 + +需要在 jenkins 系统配置中配置企业微信机器人,支持配置多个机器人 + +- 1、点击`全局设置` + +![](images/stage1-1.png) + +- 2、进入`系统设置` + +![](images/stage1-2.png) + +- 3、下拉找到`企业微信机器人`,点击`新增` + +![](images/stage1-3.png) + +- 4、添加机器人信息并测试 + +![](images/stage1-4.png) + +- 5、保存配置即可 + +### 二、配置企业微信成员的手机号信息 + +需要在 jenkins 用户信息页面,配置企业微信成员手机号码,这样 jenkins 才知道当前 job 的执行结果应该 @ 那个企业微信中成员 + +- 进入用户账号设置,配置手机号,这个手机号是用户在企业微信中成员的手机号 + +![](images/stage2-1.png)