diff --git a/src/SUMMARY.md b/src/SUMMARY.md index e672a25a2bbd54ea5c68b31483654153a0099501..fad051e2643bb8b32fb1b76eeb0bd5e580710ffa 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -18,8 +18,6 @@ - [学习仓库](course/edit/template.md) - [支持事件](course/events.md) - [支持动作](course/actions.md) - - [close-issue](course/actions/close-issue.md) - - [open-issue](course/actions/open-issue.md) - [添加课程](course/create.md) - [测试课程](course/test.md) - [发布课程](course/publish.md) diff --git a/src/course/actions.md b/src/course/actions.md index 5d05b087ea655e2f2688b4bab484351a6edb5e0f..89cff8eaf982b60eaec6104f27fba8ec1bda177f 100644 --- a/src/course/actions.md +++ b/src/course/actions.md @@ -1,17 +1,14 @@ # 支持动作 目前 Learning Lab 支持的动作包括: + +- `open_issue /create_issue` +- `open_merge_request / merge_request.create` +- `close_merge_request / merge_request.close` +- `reply / issue_comment.created / note / choice` -- close_issue -- open_issue(create_issue) -- open_merge_request(merge_request.create) -- close_merge_request(merge_request.close) -- create_branch -- delete_branch -- reply(issue_comment.created,note,choice) - -## open_issue +## open_issue /create_issue 使用`open_issue`动作来创建一个新issue,也可使用此动作的别名`create_issue`来创建 @@ -42,9 +39,9 @@ step6: | 参数 | 类型 | 描述 | 默认 | 是否为必要参数 | | --- | --- | --- | --- | --- | -| title | String | 新建issue的标题 | | 是 | -| with | String | 新建issue的描述 | | 否 | -| store | object | 此次动作要存储的变量 | | 否 | +| title | String | 新建issue的标题 | | ✓ | +| with | String | 新建issue的描述 | | | +| store | object | 此次动作要存储的变量 | | | ### 创建issue后返回result的格式 @@ -61,7 +58,7 @@ step6: ``` -## open_merge_request +## open_merge_request / merge_request.create 使用`open_merge_request`动作来创建一个新merge_request,也可使用此动作的别名`merge_request.create`来创建 @@ -90,7 +87,7 @@ step9: | 参数 | 类型 | 描述 | 默认 | 是否为必要参数 | | --- | --- | --- | --- | --- | -| with | String | merge_request的source分支和target分支,中间用逗号分隔 | | 是 | +| with | String | merge_request的source分支和target分支,中间用逗号分隔 | | ✓ | ### 创建open_merge_request后返回result的格式 @@ -107,7 +104,7 @@ step9: ``` -## close_merge_request +## close_merge_request / merge_request.close 使用`close_merge_request`动作来关闭一个merge_request,也可使用此动作的别名`merge_request.close`来创建 @@ -134,10 +131,10 @@ step9: | 参数 | 类型 | 描述 | 默认 | 是否为必要参数 | | --- | --- | --- | --- | --- | -| with | String | 存储merge_request链接的变量名,用`{{}}`包含 | | 是 | +| with | String | 存储merge_request链接的变量名,用`{{}}`包含 | | ✓ | -## reply +## reply / issue_comment.created / note / choice 使用`reply`来当前issue或merge_request中创建一条新的评论,也可使用别名`issue_comment.created`, `note`, `choice` @@ -163,5 +160,4 @@ step1: | 参数 | 类型 | 描述 | 默认 | 是否为必要参数 | | --- | --- | --- | --- | --- | -| with | String | 评论内容,可以是文件名,也可以是内容 | | 是 | - +| with | String | 评论内容,可以是文件名,也可以是内容 | | ✓ | \ No newline at end of file diff --git a/src/course/actions/close-issue.md b/src/course/actions/close-issue.md deleted file mode 100644 index c253a75a0a56d1114e22e713b9f49c8766a5098a..0000000000000000000000000000000000000000 --- a/src/course/actions/close-issue.md +++ /dev/null @@ -1,3 +0,0 @@ -# Close-issue - -关闭 Issue \ No newline at end of file diff --git a/src/course/actions/open-issue.md b/src/course/actions/open-issue.md deleted file mode 100644 index f542bd3c402e0ff2e871d7403b743acf60cba381..0000000000000000000000000000000000000000 --- a/src/course/actions/open-issue.md +++ /dev/null @@ -1,3 +0,0 @@ -# Open Issue - -开启 Issue \ No newline at end of file diff --git a/src/course/events.md b/src/course/events.md index f401c85f3dfe2e54368ef963f8e70fe5714cbccf..986bd7e8d0a405eabb7176200565fc24a1f7be58 100644 --- a/src/course/events.md +++ b/src/course/events.md @@ -44,7 +44,7 @@ step1: | 参数 | 类型 | 描述 | 默认 | 是否为必要参数 | | --- | --- | --- | --- | --- | -| with | String | 监听用户推送到的分支 | | 是 | +| with | String | 监听用户推送到的分支 | | ✓ | ## note @@ -109,10 +109,10 @@ step1: | 参数 | 类型 | 描述 | 默认 | 是否为必要参数 | | --- | --- | --- | --- | --- | -| with | String | 用户回复的内容 | | 否 | -| left | String | 正则表达式 | | 否 | -| operator | String | 操作符,这里使用正则匹配,应该为regexp | | 否 | -| right | String | 监听到符合条件的对象的属性,object_attributes为对象的所有属性,这里用到的属性为note | | 否 | +| with | String | 用户回复的内容 | | | +| left | String | 正则表达式 | | | +| operator | String | 操作符,这里使用正则匹配,应该为regexp | | | +| right | String | 监听到符合条件的对象的属性,object_attributes为对象的所有属性,这里用到的属性为note | | | ## issue