feat: add check-issue & remove labels (#12)

Author: xrkffgg

.env

@@ -11,6 +11,7 @@ yarn-debug.log*
 yarn-error.log*
 
 # Private
+.env
 
 # misc
 .DS_Store

.gitignore

@@ -6,6 +6,8 @@ English | [简体中文](./README.zh-CN.md)
 
 A GitHub Action to help you manage issues
 
+Online documentation | [Changelog](./changelog.md)
+
 ## 😎 Why use GitHub Action?
 
 1. Complete free.
@@ -26,12 +28,14 @@ A GitHub Action to help you manage issues
   - [`lock-issue`](#lock-issue)
   - [`open-issue`](#open-issue)
   - [`remove-assignees`](#remove-assignees)
+  - [`remove-labels`](#remove-labels)
   - [`set-labels`](#set-labels)
   - [`unlock-issue`](#unlock-issue)
   - [`update-comment`](#update-comment)
   - [`update-issue`](#update-issue)
 - ⭐ Advanced
   - [`check-inactive`](#check-inactive)
+  - [`check-issue`](#check-issue)
   - [`close-issues`](#close-issues)
   - [`find-comments`](#find-comments)
   - [`lock-issues`](#lock-issues)
@@ -325,6 +329,31 @@ Remove the person designated by issue.
 
 ⏫ [Back to list](#List)
 
+#### `remove-labels`
+
+Remove the specified labels.
+
+```yml
+- name: Remove labels
+    uses: actions-cool/[email protected]
+    with:
+      actions: 'remove-labels'
+      token: ${{ secrets.GITHUB_TOKEN }}
+      issue-number: ${{ github.event.issue.number }}
+      labels: 'xx'
+```
+
+| Param | Desc  | Type | Required | Version |
+| -- | -- | -- | -- | -- |
+| actions | Action type | string | ✔ | v1.2 |
+| token | [Token explain](#token) | string | ✔ | v1.2 |
+| issue-number | The number of issue | number | ✔ | v1.2 |
+| labels | The removed labels. When it is a blank character, do not remove | string | ✔ | v1.2 |
+
+- `labels` supports multiple, such as `x1,x2,x3`, only the labels added by the issue will be removed
+
+⏫ [Back to list](#List)
+
 #### `set-labels`
 
 Replace the labels of issue.
@@ -449,7 +478,7 @@ Update the specified issue according to the `issue-number`.
 
 ### ⭐ Advanced
 
-It is not recommended to use multiple actions for advanced usage.
+Advanced usage is not recommended to use multiple actions at the same time.
 
 #### `check-inactive`
 
@@ -495,6 +524,60 @@ jobs:
 - `inactive-day`: When entering, it will filter the issue update time earlier than the current time minus the number of inactive days. If not entered, all
 - `inactive-label`: The default is `inactive`, others can be customized. When the project does not contain the label, it will be created automatically
 
+⏫ [Back to list](#List)
+
+#### `check-issue`
+
+Check whether the issue meets the conditions according to the passed parameters and `issue-number`, and return a boolean value.
+
+The effect of the following example is: when an issue is newly opened, verify whether the current issue designator contains `x1` or `x2`. If one designated person is satisfied, the verification will pass, and at the same time, verify whether the title meets the conditions. The conditions are as follows:
+
+```
+x1 + y1
+x2 + y1
+x1 + y2
+x2 + y2
+
+"x1y3y2"  true
+"1x2y"    false
+"y2 x1"   true
+```
+
+```yml
+name: Check Issue
+
+on:
+  issues:
+    types: [edited]
+
+jobs:
+  check-issue:
+    runs-on: ubuntu-latest
+    steps:
+      - name: check-issue
+        uses: actions-cool/issues-helper@v1
+        with:
+          actions: 'check-issue'
+          token: ${{ secrets.GITHUB_TOKEN }}
+          issue-number: ${{ github.event.issue.number }}
+          assignee-includes: 'x1,x2'
+          title-includes: 'x1,x2/y1,y2'
+```
+
+| Param | Desc  | Type | Required | Version |
+| -- | -- | -- | -- | -- |
+| actions | Action type | string | ✔ | v1.2 |
+| token | [Token explain](#token) | string | ✔ | v1.2 |
+| issue-number | The number of issue | number | ✔ | v1.2 |
+| assignee-includes | Assignees contains check | string | ✔ | v1.2 |
+| title-includes | Title contains check | string | ✔ | v1.2 |
+| body-includes | Body contains check | string | ✔ | v1.2 |
+
+- `title-includes` `body-includes` supports the format `x1,x2` or `x1,x2/y1,y2`. Only supports two levels
+- Return `check-result`
+
+⏫ [Back to list](#List)
+
 #### `close-issues`
 
 Every 7 days at UTC 0, close the issues that have been filled with the `need info` label and have not been active for more than 7 days.

README.md

@@ -6,6 +6,8 @@
 
 一个帮你管理 issues 的 GitHub Action
 
+在线文档 | [更新日志](./changelog.zh-CN.md)
+
 ## 😎 为什么用 GitHub Action？
 
 1. 完全免费。
@@ -26,12 +28,14 @@
   - [`lock-issue`](#lock-issue)
   - [`open-issue`](#open-issue)
   - [`remove-assignees`](#remove-assignees)
+  - [`remove-labels`](#remove-labels)
   - [`set-labels`](#set-labels)
   - [`unlock-issue`](#unlock-issue)
   - [`update-comment`](#update-comment)
   - [`update-issue`](#update-issue)
 - ⭐ 进 阶
   - [`check-inactive`](#check-inactive)
+  - [`check-issue`](#check-issue)
   - [`close-issues`](#close-issues)
   - [`find-comments`](#find-comments)
   - [`lock-issues`](#lock-issues)
@@ -325,6 +329,31 @@ jobs:
 
 ⏫ [返回列表](#列-表)
 
+#### `remove-labels`
+
+移除指定 labels。
+
+```yml
+- name: Remove labels
+    uses: actions-cool/[email protected]
+    with:
+      actions: 'remove-labels'
+      token: ${{ secrets.GITHUB_TOKEN }}
+      issue-number: ${{ github.event.issue.number }}
+      labels: 'xx'
+```
+
+| 参数 | 描述 | 类型 | 必填 | 版本 |
+| -- | -- | -- | -- | -- |
+| actions | 操作类型 | string | ✔ | v1.2 |
+| token | [token 说明](#token) | string | ✔ | v1.2 |
+| issue-number | 指定的 issue | number | ✔ | v1.2 |
+| labels | 移除的 labels。当为空字符时，不进行移除 | string | ✔ | v1.2 |
+
+- `labels` 支持多个，如 `x1,x2,x3`，只会移除 issue 已添加的 labels
+
+⏫ [返回列表](#列-表)
+
 #### `set-labels`
 
 替换 issue 的 labels。
@@ -449,7 +478,7 @@ jobs:
 
 ### ⭐ 进 阶
 
-进阶用法不建议 actions 多重使用。
+进阶用法不建议 actions 多个一次同时使用。
 
 #### `check-inactive`
 
@@ -495,6 +524,60 @@ jobs:
 - `inactive-day`：当输入时，会筛选 issue 更新时间早于当前时间减去非活跃天数。不填时，会查询所有
 - `inactive-label`：默认为 `inactive`，可自定义其他。当项目未包含该 label 时，会自动新建
 
+⏫ [返回列表](#列-表)
+
+#### `check-issue`
+
+根据传入的参数和 `issue-number` 来检查该 issue 是否满足条件，返回一个布尔值。
+
+下面的例子效果是：当 issue 新开时，校验当前 issue 指定人是否包含 `x1` 或者 `x2`，满足一个指定人即可校验通过，同时校验标题是否满足条件。条件如下：
+
+```
+x1 + y1
+x2 + y1
+x1 + y2
+x2 + y2
+
+"x1y3y2"  true
+"1x2y"    false
+"y2 x1"   true
+```
+
+```yml
+name: Check Issue
+
+on:
+  issues:
+    types: [edited]
+
+jobs:
+  check-issue:
+    runs-on: ubuntu-latest
+    steps:
+      - name: check-issue
+        uses: actions-cool/issues-helper@v1
+        with:
+          actions: 'check-issue'
+          token: ${{ secrets.GITHUB_TOKEN }}
+          issue-number: ${{ github.event.issue.number }}
+          assignee-includes: 'x1,x2'
+          title-includes: 'x1,x2/y1,y2'
+```
+
+| 参数 | 描述 | 类型 | 必填 | 版本 |
+| -- | -- | -- | -- | -- |
+| actions | 操作类型 | string | ✔ | v1.2 |
+| token | [token 说明](#token) | string | ✔ | v1.2 |
+| issue-number | 指定的 issue | number | ✔ | v1.2 |
+| assignee-includes | 是否包含指定人 | string | ✔ | v1.2 |
+| title-includes | 标题包含校验 | string | ✔ | v1.2 |
+| body-includes | 内容包含校验 | string | ✔ | v1.2 |
+
+- `title-includes` `body-includes` 支持格式 `x1,x2` 或者 `x1,x2/y1,y2`。只支持两个层级
+- 返回 `check-result`
+
+⏫ [返回列表](#列-表)
+
 #### `close-issues`
 
 每 7 天 UTC 0 时，关闭已填加 `need info` label 且 7 天以上未活跃的 issues。

README.zh-CN.md

@@ -1,9 +1,9 @@
 name: 'Issues Helper'
-description: 'Some operations on issue'
+description: 'A GitHub Action to help you manage issues'
 author: 'xrkffgg'
 branding:
   icon: 'message-square'
-  color: 'blue'
+  color: 'black'
 inputs:
   actions:
     description: 'Action name'
@@ -32,6 +32,8 @@ inputs:
     description: 'Find comments direction'
   comment-auth:
     description: 'Find comments query auth'
+  assignee-includes:
+    description: 'Check use'
   body-includes:
     description: 'Query use'
   title-includes:
@@ -55,6 +57,8 @@ outputs:
     description: 'Create comment ID'
   comments:
     description: 'Find comments'
+  check-result:
+    description: 'Check issue'
 runs:
   using: node12
   main: 'dist/index.js'

action.yml

@@ -0,0 +1,35 @@
+# ✨ Changelog
+
+## Version rules
+
+- Use two-level semantic version, such as v1, v1.1, v2, v2.1
+- v1 represents the initial version
+- The fixes and additions to the v1 version will be released to the v1.1 version
+- When the released v1.x runs stable for a certain period of time, release the advanced v2 version
+
+## Version selection
+
+- It is recommended to use the latest releases version. It can be seen in [releases](https://github.com/actions-cool/issues-helper/releases)
+
+- You can also refer to the update log below to select the version
+
+- It also supports the direct use of branch versions. Such as:
+
+```yml
+- name: Issues Helper
+  uses: actions-cool/issues-helper@main
+```
+
+## Change Log
+
+### v1.1
+
+`2020.12.24`
+
+- fix: yml not support array. [#11](https://github.com/actions-cool/issues-helper/pull/11)
+
+### v1
+
+`2020.12.23`
+
+🎉 First release.

changelog.md

@@ -0,0 +1,35 @@
+# ✨ 更新日志
+
+## 版本规则
+
+- 采用两级语义化版本，如v1、v1.1、v2、v2.1
+- v1 表示初始版本
+- 对 v1 版本的修复和新增会发布到 v1.1 版本
+- 当发布的 v1.x 运行一定时间稳定后，发布进阶 v2 版本
+
+## 版本选择
+
+- 建议采用最新 releases 版本。可在 [releases](https://github.com/actions-cool/issues-helper/releases) 看到
+
+- 同时也可参照下面的更新日志来选择版本
+
+- 也支持直接使用分支版本。如：
+
+```yml
+- name: Issues Helper
+  uses: actions-cool/issues-helper@main
+```
+
+## 更新日志
+
+### v1.1
+
+`2020.12.24`
+
+- fix: yml not support array. [#11](https://github.com/actions-cool/issues-helper/pull/11)
+
+### v1
+
+`2020.12.23`
+
+🎉 First release.