Compare commits

..

11 Commits
v3.4.0 ... 2.x

Author SHA1 Message Date
xrkffgg
89cd1fdcb0 Merge pull request #104 from actions-cool/main
branch: merge main into 2.x
2022-02-08 17:07:46 +08:00
xrkffgg
bce5050c75 Merge pull request #97 from actions-cool/main
branch: sync new
2021-10-19 20:18:55 +08:00
xrkffgg
b98b1e6b69 Merge pull request #94 from actions-cool/main
branch: merge main into 2.x
2021-10-09 15:04:31 +08:00
xrkffgg
fda4f9f2cf Merge pull request #91 from actions-cool/main
branch: merge main into 2.x
2021-09-24 09:46:39 +08:00
xrkffgg
13910364db Merge pull request #87 from actions-cool/main
branch: sync main into 2.x
2021-09-05 19:45:02 +08:00
xrkffgg
c0e82cce30 Merge pull request #85 from actions-cool/main
branch: merge main into 2.x
2021-08-19 17:32:36 +08:00
xrkffgg
70fe52f090 Merge pull request #76 from actions-cool/main
branch: sync
2021-08-11 09:29:49 +08:00
xrkffgg
5d83b76a66 Merge pull request #67 from actions-cool/main
branch: merge main into 2.x
2021-03-21 20:36:54 +08:00
xrkffgg
97a4858559 Merge pull request #62 from actions-cool/main
branch: merge main into 2.x
2021-02-18 10:05:17 +08:00
xrkffgg
6fd897b145 branch: merge main into 2.x-v2.1.1 (#60) 2021-02-03 10:00:50 +08:00
xrkffgg
feaa13809b Merge pull request #55 from actions-cool/main
branch: merge main into 2.x
2021-02-02 20:40:37 +08:00
76 changed files with 9925 additions and 15684 deletions

View File

@@ -1,8 +0,0 @@
es/**/*
lib/**/*
node_modules
_site
dist
coverage
**/*.d.ts
.eslintrc.js

View File

@@ -1,9 +0,0 @@
module.exports = {
extends: [require.resolve("@umijs/fabric/dist/eslint")],
plugins: ["simple-import-sort"],
rules: {
"simple-import-sort/imports": "error",
"simple-import-sort/exports": "error",
"@typescript-eslint/no-parameter-properties": 0,
},
};

View File

@@ -10,7 +10,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- run: yarn
- run: npm install
- run: npm run docs:build
- name: Deploy
uses: peaceiris/actions-gh-pages@v3

View File

@@ -3,4 +3,3 @@ lib/
docs-dist/
node_modules/
src/.umi/
src/main.ts

View File

@@ -3,6 +3,4 @@ const fabric = require('@umijs/fabric');
module.exports = {
...fabric.prettier,
arrowParens: 'avoid',
importOrder: ['^@formily/(.*)', '^@(.*)$', '^[./]'],
importOrderSeparation: true,
};

View File

@@ -3,66 +3,43 @@ import { defineConfig } from 'dumi';
const name = 'issues-helper';
const logo =
'https://gw.alipayobjects.com/mdn/rms_f97235/afts/img/A*8xDgSL-O6O4AAAAAAAAAAAAAARQnAQ';
export default defineConfig({
title: 'Issues Helper',
mode: 'site',
favicon: logo,
logo,
favicon: 'https://avatars1.githubusercontent.com/u/73879334?s=200&v=4',
logo: 'https://avatars1.githubusercontent.com/u/73879334?s=200&v=4',
exportStatic: {},
ssr: {},
outputPath: '../docs-dist',
resolve: {
includes: ['./docs'],
},
outputPath: 'docs-dist',
hash: true,
base: `/${name}/`,
publicPath: `/${name}/`,
locales: [
['en-US', 'English'],
['zh-CN', '中文'],
['en-US', 'English'],
],
theme: {
'@c-primary': '#1890ff',
},
navs: {
'en-US': [
{ title: 'Guide', path: '/guide' },
{ title: 'Base', path: '/base' },
{ title: 'Advanced', path: '/advanced' },
{ title: 'Changelog', path: '/changelog' },
'zh-CN': [
{ title: '指 南', path: '/guide' },
{ title: '基 础', path: '/base' },
{ title: '进 阶', path: '/advanced' },
{ title: '更新日志', path: '/changelog' },
{ title: '国内镜像', path: 'https://issues-helper.gitee.io' },
{ title: 'GitHub', path: 'https://github.com/actions-cool/issues-helper' },
],
'zh-CN': [
{ title: '指 南', path: '/zh-CN/guide' },
{ title: '基 础', path: '/zh-CN/base' },
{ title: '进 阶', path: '/zh-CN/advanced' },
{ title: '更新日志', path: '/zh-CN/changelog' },
'en-US': [
{ title: 'Guide', path: '/en-US/guide' },
{ title: 'Base', path: '/en-US/base' },
{ title: 'Advanced', path: '/en-US/advanced' },
{ title: 'Changelog', path: '/en-US/changelog' },
{ title: 'GitHub', path: 'https://github.com/actions-cool/issues-helper' },
],
},
menus: {
'/guide': [
{
title: '🍭 Guide',
children: ['/guide/index', '/guide/start'],
},
{
title: '🎁 Reference',
path: '/guide/ref',
},
{
title: '🎗 Note',
path: '/guide/note',
},
{
title: '💬 FAQ',
path: '/guide/faq',
},
],
'/zh-CN/guide': [
{
title: '🍭 介 绍',
children: ['/guide/index', '/guide/start'],
@@ -80,5 +57,23 @@ export default defineConfig({
path: '/guide/faq',
},
],
'/en-US/guide': [
{
title: '🍭 Guide',
children: ['/guide/index', '/guide/start'],
},
{
title: '🎁 Reference',
path: '/guide/ref',
},
{
title: '🎗 Note',
path: '/guide/note',
},
{
title: '💬 FAQ',
path: '/guide/faq',
},
],
},
});

View File

@@ -4,81 +4,8 @@
💄 Perf
📝 Docs
⚡️ Code style
🛠 refactor
-->
## v3.4.0
`2023.02.06`
- 🚀 feat: support `toggle-labels`. [#132](https://github.com/actions-cool/issues-helper/pull/132) [@Wxh16144](https://github.com/Wxh16144)
## v3.3.3
`2022.11.13`
- 🐞 fix: body null case. [#129](https://github.com/actions-cool/issues-helper/pull/129) [@madmansn0w](https://github.com/madmansn0w)
## v3.3.2
`2022.10.21`
- 💄 chore: update `@actions/core` version. [#125](https://github.com/actions-cool/issues-helper/pull/125) [@wjz304](https://github.com/wjz304)
## v3.3.1
`2022.10.19`
- 🐞 fix: body null case. [#123](https://github.com/actions-cool/issues-helper/pull/123)
## v3.3.0
`2022.09.02`
- 🚀 feat: add `get-issue`. [#114](https://github.com/actions-cool/issues-helper/pull/114)
## v3.2.1
`2022.08.31`
- 🐞 fix: mark-duplicate labels invalid. [#116](https://github.com/actions-cool/issues-helper/pull/116)
## v3.2.0
`2022.08.26`
- 🚀 feat: add `$exclude-empty` for `exclude-labels`. [#112](https://github.com/actions-cool/issues-helper/pull/112)
- When set to include `$exclude-empty`, no label issue can be excluded
## v3.1.0
`2022.08.09`
- 🚀 feat: add reason for closing issue. [#110](https://github.com/actions-cool/issues-helper/pull/110) [@Xhofe](https://github.com/Xhofe)
## v3.0.1
`2022.08.01`
- 🐞 fix: check will undefined.
## v3.0.0
`2022.02.15`
- 🚀 New Feature
- `mark-assignees`: Comment quick settings assignees
- `find-issues`: Conditional query current warehouse issues
- 🐞 Bug Fix
- Fixed `find-comments` return result direction not working
- Fix `lock-issues` lock and comment order issue
- 🛠 Refactor
- `contents` renamed to easy-to-understand `emoji`
- `issue-emojis` renamed to `issue-emoji`
- deleteComment updateComment no longer supports `out-comments`, keeping pure functionality
- Remove title body default
- `month-statistics` is removed
## v2.5.0
`2021.10.19`

View File

@@ -1,15 +1,8 @@
## Dev
### Code
All code is in `/src`.
The online code is in `/web`.
## release
direct `npm run pub`
完整版本在网页上进行
### 手动
### 替换小版本
- 删除 v2 tag
- git push origin :refs/tags/v2
- 把最新的 v2.1.0 推送到 远端 v2 tag

1234
README.en-US.md Normal file

File diff suppressed because it is too large Load Diff

1578
README.md

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -1,12 +1,11 @@
// **************************************************************************
// step1: add to end
// step2: npm run users
// step3: push 3 files & open a new PR
/**
* @param {string} url github repo
* @param {string} logo logo url
* @param {string} width auto use rectangle logo
* @param {string} url github地址
* @param {string} logo logo地址
* @param {string} width 自定义宽度,设置 auto 用于长型 logo
*/
const users = [
@@ -31,8 +30,8 @@ const users = [
logo: 'https://user-images.githubusercontent.com/29775873/129506134-55044c85-24cd-47d3-81ef-dba842214d71.png'
},
{
url: 'https://github.com/mui/material-ui',
logo: 'https://avatars.githubusercontent.com/u/33663932?s=200&v=4'
url: 'https://github.com/mui-org/material-ui',
logo: 'https://avatars2.githubusercontent.com/u/33663932?s=200&v=4'
},
{
url: 'https://github.com/lijinke666/react-music-player',
@@ -50,6 +49,10 @@ const users = [
url: 'https://github.com/react-component',
logo: 'https://avatars3.githubusercontent.com/u/9441414?s=200&v=4'
},
{
url: 'https://github.com/ant-design/pro-components',
logo: 'https://avatars1.githubusercontent.com/u/12101536?s=200&v=4'
},
{
url: 'https://github.com/prettier/prettier',
logo: 'https://user-images.githubusercontent.com/29775873/129505900-ca248179-2435-429d-9fd3-779206bcd899.png',
@@ -87,26 +90,6 @@ const users = [
url: 'https://github.com/antvis/S2',
logo: 'https://gw.alipayobjects.com/mdn/rms_56cbb2/afts/img/A*TI8XSK3W0EkAAAAAAAAAAAAAARQnAQ',
},
{
url: 'https://github.com/twbs/bootstrap',
logo: 'https://getbootstrap.com/docs/5.1/assets/brand/bootstrap-logo-shadow.png',
},
{
url: 'https://github.com/nolimits4web/swiper',
logo: 'https://user-images.githubusercontent.com/29775873/156721728-3b0021ea-6932-4a77-a104-2e0bad97346e.png',
},
{
url: 'https://github.com/vitest-dev/vitest',
logo: 'https://user-images.githubusercontent.com/11247099/145112184-a9ff6727-661c-439d-9ada-963124a281f7.png',
},
{
url: 'https://github.com/electron/electron',
logo: 'https://avatars.githubusercontent.com/u/13409222?s=200&v=4',
},
{
url: 'https://github.com/ant-design/ant-design-mobile',
logo: 'https://gw.alipayobjects.com/zos/bmw-prod/b874caa9-4458-412a-9ac6-a61486180a62.svg',
},
];
// **************************************************************************

View File

@@ -28,9 +28,6 @@ inputs:
description: 'Issue assignees'
random-to:
description: 'Issue assignees random to'
close-reason:
description: 'Issue close reason'
# label
labels:
description: 'Issue labels'
@@ -45,19 +42,20 @@ inputs:
description: 'Issue state'
update-mode:
description: 'Body update mode'
emoji:
contents:
description: 'Issue reactions emoji'
direction:
description: 'Find direction'
description: 'Find comments direction'
# comments
comment-auth:
description: 'Find comments query auth'
out-comments:
description: 'Find comments out comments'
assignee-includes:
description: 'Check use'
body-includes:
description: 'Query use'
# check
title-excludes:
description: 'Remove some to check title whether empty.'
@@ -69,7 +67,7 @@ inputs:
description: 'Query use'
issue-mentioned:
description: 'Query use'
issue-emoji:
issue-contents:
description: 'For welcome'
issue-state:
description: 'Query use'
@@ -81,8 +79,7 @@ inputs:
description: 'Issue label set use'
exclude-labels:
description: 'Query issues exclude labels'
assign-command:
description: 'For mark-assigness'
duplicate-command:
description: 'For mark-duplicate'
duplicate-labels:
@@ -93,29 +90,21 @@ inputs:
description: 'For remove labels'
close-issue:
description: 'For mark-duplicate'
count-lables:
description: 'For month-statistics'
count-comments:
description: 'For month-statistics'
outputs:
issue-number:
description: 'Issue Number'
issue-title:
description: 'Issue Title'
issue-body:
description: 'Issue Body'
issue-labels:
description: 'Issue labels'
issue-assignees:
description: 'Issue assignees'
issue-state:
description: 'Issue state'
description: 'Create Issue Number'
comment-id:
description: 'Create comment ID'
comments:
description: 'Find comments'
issues:
description: 'Find issues'
check-result:
description: 'Check issue'
runs:
using: node16
using: node12
main: 'dist/index.js'

8520
dist/index.js vendored

File diff suppressed because one or more lines are too long

View File

@@ -22,7 +22,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: check-inactive
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'check-inactive'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -32,9 +32,9 @@ jobs:
| Param | Desc | Type | Required |
| -- | -- | -- | -- |
| actions | Action type | string | ✔ |
| token | [Token explain](/guide/ref#-token) | string | |
| token | [Token explain](/en-US/guide/ref#-token) | string | |
| body | When operating an issue, you can comment. Do not comment when not typing | string | ✖ |
| contents | Add [reaction](/guide/ref#-reactions-type) for this comment | string | ✖ |
| contents | Add [reaction](/en-US/guide/ref#-reactions-type) for this comment | string | ✖ |
| labels | Labels filtering | string | ✖ |
| issue-state | State filtering | string | ✖ |
| issue-assignee | Assignee filtering | string | ✖ |
@@ -51,7 +51,6 @@ jobs:
- `issue-assignee`: Multiplayer is not supported. If you do not enter or enter *, all will be searched. Entering `none` will query issues for which the specified person is not added
- `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
- `exclude-labels`: When set to include `$exclude-empty`, no label issue can be excluded
## `check-issue`
@@ -61,7 +60,7 @@ The effect of the following example is: when an issue is newly opened, verify wh
If one designated person is satisfied, the verification will pass, and at the same time, verify whether the title meets the conditions.
[Check rules](/guide/ref#-includes-check-rules)
[Check rules](/en-US/guide/ref#-includes-check-rules)
```yml
name: Check Issue
@@ -75,7 +74,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: check-issue
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'check-issue'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -87,7 +86,7 @@ jobs:
| Param | Desc | Type | Required |
| -- | -- | -- | -- |
| actions | Action type | string | ✔ |
| token | [Token explain](/guide/ref#-token) | string | |
| token | [Token explain](/en-US/guide/ref#-token) | string | |
| issue-number | The number of issue. When not input, it will be obtained from the trigger event | number | ✖ |
| assignee-includes | Assignees contains check | string | ✖ |
| title-includes | Title contains check | string | ✖ |
@@ -113,7 +112,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: close-issues
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'close-issues'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -124,9 +123,9 @@ jobs:
| Param | Desc | Type | Required |
| -- | -- | -- | -- |
| actions | Action type | string | ✔ |
| token | [Token explain](/guide/ref#-token) | string | |
| token | [Token explain](/en-US/guide/ref#-token) | string | |
| body | When operating an issue, you can comment. Do not comment when not typing | string | ✖ |
| contents | Add [reaction](/guide/ref#-reactions-type) for this comment | string | ✖ |
| contents | Add [reaction](/en-US/guide/ref#-reactions-type) for this comment | string | ✖ |
| labels | Labels filtering | string | ✖ |
| issue-assignee | Assignee filtering | string | ✖ |
| issue-creator | Creator filtering | string | ✖ |
@@ -135,12 +134,10 @@ jobs:
| title-includes | Title filtering | string | ✖ |
| inactive-day | Inactive days filtering | number | ✖ |
| exclude-labels | Exclude labels filtering | string | ✖ |
| close-reason | Reason for closing. Default `not_planned`, another `completed` | string | ✖ |
- `labels`: When there are multiple, the query will have multiple at the same time. If not entered, all
- `issue-assignee`: Multiplayer is not supported. If you do not enter or enter *, all will be searched. Entering `none` will query issues for which the specified person is not added
- `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
- `exclude-labels`: When set to include `$exclude-empty`, no label issue can be excluded
## `find-comments`
@@ -148,7 +145,7 @@ Find the current warehouse issue No. 1, the creator is k and the content contain
```yml
- name: Find comments
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'find-comments'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -160,7 +157,7 @@ Find the current warehouse issue No. 1, the creator is k and the content contain
| Param | Desc | Type | Required |
| -- | -- | -- | -- |
| actions | Action type | string | ✔ |
| token | [Token explain](/guide/ref#-token) | string | |
| token | [Token explain](/en-US/guide/ref#-token) | string | |
| issue-number | The number of issue. When not input, it will be obtained from the trigger event | number | ✖ |
| comment-auth | Comment creator, all will be queried if not filled | string | ✖ |
| body-includes | Comment content includes filtering, no verification if not filled | string | ✖ |
@@ -177,46 +174,6 @@ Find the current warehouse issue No. 1, the creator is k and the content contain
- `direction` defaults to ascending order, only when `desc` is set, descending order will be returned
- The `created` `updated` in the returned array, determined by the environment, will be UTC +0
## `find-issues`
Find the current repository, the creator is k , the title contains `this` , the body contains `that`, and the list of issues in the open state.
```yml
- name: Find issues
uses: actions-cool/issues-helper@v3
with:
actions: 'find-issues'
token: ${{ secrets.GITHUB_TOKEN }}
issue-creator: 'k'
issue-state: 'open'
title-includes: 'this'
body-includes: 'that'
```
| Param | Desc | Type | Required |
| -- | -- | -- | -- |
| actions | Action type | string | ✔ |
| token | [Token explain](/guide/ref#-token) | string | ✖ |
| issue-state | State filtering | string | ✖ |
| issue-creator | Creator filtering | string | ✖ |
| title-includes | Title filtering | string | ✖ |
| body-includes | Body filtering | string | ✖ |
| exclude-labels | Exclude labels filtering | string | ✖ |
| inactive-day | Inactive days filtering | number | ✖ |
| direction | Return sort | string | ✖ |
- Returns `issues` in the following format:
```js
[
{number: 1, auth: 'x', body: 'xxx', body: 'xxx', state: 'open', created: '', updated: ''},
{number: 2, auth: 'x', body: 'xxx', body: 'xxx', state: 'closed', created: '', updated: ''},
]
```
- `direction` defaults to ascending order, only when `desc` is set, descending order will be returned
- The `created` `updated` in the returned array, determined by the environment, will be UTC +0
- `exclude-labels`: When set to include `$exclude-empty`, no label issue can be excluded
## `lock-issues`
@@ -234,7 +191,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: lock-issues
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'lock-issues'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -245,9 +202,9 @@ jobs:
| Param | Desc | Type | Required |
| -- | -- | -- | -- |
| actions | Action type | string | ✔ |
| token | [Token explain](/guide/ref#-token) | string | |
| token | [Token explain](/en-US/guide/ref#-token) | string | |
| body | When operating an issue, you can comment. Do not comment when not typing | string | ✖ |
| contents | Add [reaction](/guide/ref#-reactions-type) for this comment | string | ✖ |
| contents | Add [reaction](/en-US/guide/ref#-reactions-type) for this comment | string | ✖ |
| labels | Labels filtering | string | ✖ |
| issue-state | State filtering | string | ✖ |
| issue-assignee | Assignee filtering | string | ✖ |
@@ -263,160 +220,43 @@ jobs:
- `issue-state`: The default is `all`. Optional value `open` `closed`, when these 2 items are not, both are `all`
- `issue-assignee`: Multiplayer is not supported. If you do not enter or enter *, all will be searched. Entering `none` will query issues for which the specified person is not added
- `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
- `exclude-labels`: When set to include `$exclude-empty`, no label issue can be excluded
## `mark-assignees`
## `month-statistics`
Quickly assign person, only for the issue to add editor comments.
At 1 o'clock on the 1st of each month, an issue is generated for the statistics of the previous month.
```yml
name: Issue Mark Assignees
```
name: Issue Month Statistics
on:
issue_comment:
types: [created, edited]
schedule:
- cron: "0 1 1 * *"
jobs:
mark-assignees:
month-statistics:
runs-on: ubuntu-latest
steps:
- name: mark-assignees
uses: actions-cool/issues-helper@v3
- name: month-statistics
uses: actions-cool/issues-helper@v2
with:
actions: 'mark-assignees'
actions: 'month-statistics'
token: ${{ secrets.GITHUB_TOKEN }}
count-lables: 'true'
```
| Param | Desc | Type | Required |
| -- | -- | -- | -- |
| actions | Action type | string | ✔ |
| token | [Token explain](/guide/ref#-token) | string | |
| assign-command | Simple commands can be set, such as: `/a` | string | ✖ |
| require-permission | Permission required, default is `write` | string | ✖ |
| token | [Token explain](/en-US/guide/ref#-token) | string | |
| labels | The labels for the new issue | string | ✖ |
| assignees | The assignees for the new issue | string | ✖ |
| count-lables | Whether the new issue count labels | string | ✖ |
| count-comments | Whether the new issue count comments | string | ✖ |
- `assign-command`: default `/assign`
- `require-permission`: Optional values are `admin`, `write`, `read`, `none`
- If the team member sets the `read` permission, it is `read`
- If the external Collaborator is set to `read` permission, it is `read`
- Ordinary users have `read` permission
- When set `write`, `admin` and `write` meet the conditions
- The new issue title defaults to `[Current repo] Month Statistics: Year-Month`
- `count-lables`: You can set `'true'` to add labels statistics
- `count-comments`: You can set `'true'` to add comments statistics
## `mark-duplicate`
As follows:
Quickly mark duplicate questions, only for issue new comments or edit comments.
```yml
name: Issue Mark Duplicate
on:
issue_comment:
types: [created, edited]
jobs:
mark-duplicate:
runs-on: ubuntu-latest
steps:
- name: mark-duplicate
uses: actions-cool/issues-helper@v3
with:
actions: 'mark-duplicate'
token: ${{ secrets.GITHUB_TOKEN }}
```
| Param | Desc | Type | Required |
| -- | -- | -- | -- |
| actions | Action type | string | ✔ |
| token | [Token explain](/guide/ref#-token) | string | ✖ |
| duplicate-command | Simple commands can be set, such as: `/d` | string | ✖ |
| duplicate-labels | Add additional labels to this issue | string | ✖ |
| remove-labels | Set removable labels | string | ✖ |
| labels | Replace the labels of the issue | string | ✖ |
| emoji | Add [emoji](/guide/ref#-emoji-type) for this comment | string | ✖ |
| close-issue | Whether to close the issue at the same time | string | ✖ |
| require-permission | Permission required, default is `write` | string | ✖ |
| close-reason | Reason for closing. Default `not_planned`, another `completed` | string | ✖ |
- `duplicate-command`: When setting concise commands, while still supporting the original `Duplicate of`. Block content contains `?`
- `labels`: Highest priority
- `close-issue`: Both `true` or `'true'` can take effect
- `require-permission`: Optional values are `admin`, `write`, `read`, `none`
- If the team member sets the `read` permission, it is `read`
- If the external Collaborator is set to `read` permission, it is `read`
- Ordinary users have `read` permission
- When set `write`, `admin` and `write` meet the conditions
<Alert>
Note: Duplicate created with the concise command does not display the content of the red box in the figure below. But in fact this has no effect.
</Alert>
![](https://gw.alipayobjects.com/mdn/rms_f97235/afts/img/A*PN2tS7PjDQ4AAAAAAAAAAAAAARQnAQ)
## `toggle-labels`
When an issue is reopened, the set labels are removed if they already exist, otherwise they are added.
```yml
name: Toggle Labels
on:
issues:
types: [reopened]
jobs:
toggle-labels:
runs-on: ubuntu-latest
steps:
- name: Toggle labels
uses: actions-cool/issues-helper@v3
with:
actions: 'toggle-labels'
token: ${{ secrets.GITHUB_TOKEN }}
issue-number: ${{ github.event.issue.number }}
labels: 'unread,outdated'
```
| Param | Desc | Type | Required |
| -- | -- | -- | -- |
| actions | Action type | string | ✔ |
| token | [Token explain](/guide/ref#-token) | string | ✖ |
| issue-number | The number of issue. When not input, it will be obtained from the trigger event | number | ✖ |
| labels | The toggle labels. Delete if the label already exists, add if it does not exist | string | ✖ |
## `welcome`
When an issue is created, the user who created the issue for the first time is welcome.
If the user is not creating for the first time, there is no operation.
```yml
name: Issue Welcome
on:
issues:
types: [opened]
jobs:
issue-welcome:
runs-on: ubuntu-latest
steps:
- name: welcome
uses: actions-cool/issues-helper@v3
with:
actions: 'welcome'
token: ${{ secrets.GITHUB_TOKEN }}
body: hi @${{ github.event.issue.user.login }}, welcome!
labels: 'welcome1, welcome2'
assignees: 'xx1'
issue-emoji: '+1, -1, eyes'
```
| Param | Desc | Type | Required |
| -- | -- | -- | -- |
| actions | Action type | string | ✔ |
| token | [Token explain](/guide/ref#-token) | string | ✖ |
| body | Comment on the welcome content, no comment if you leave it blank | string | ✖ |
| labels | Add labels to this issue | string | ✖ |
| assignees | Add assignees to this issue | string | ✖ |
| issue-emoji | Add [emoji](/guide/ref#-emoji-type) to this issue| string | ✖ |
- If these 4 options are not filled, no operation
![](../public/month.png)

258
docs/advanced.md Normal file
View File

@@ -0,0 +1,258 @@
---
toc: menu
---
# 🌟 进 阶
进阶用法不建议 actions 多个一次同时使用。
## `check-inactive`
每月 1 号 UTC 0 时,对所有 30 天以上未活跃的 issues 增加 `inactive` 标签。
```yml
name: Check inactive
on:
schedule:
- cron: "0 0 1 * *"
jobs:
check-inactive:
runs-on: ubuntu-latest
steps:
- name: check-inactive
uses: actions-cool/issues-helper@v2
with:
actions: 'check-inactive'
token: ${{ secrets.GITHUB_TOKEN }}
inactive-day: 30
```
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/guide/ref#-token-说明) | string | ✔ |
| body | 操作 issue 时,可进行评论。不填时,不评论 | string | ✖ |
| contents | 为该评论增加 [reaction](/guide/ref#-reactions-类型) | string | ✖ |
| labels | 标签筛选 | string | ✖ |
| issue-state | 状态筛选 | string | ✖ |
| issue-assignee | 指定人筛选 | string | ✖ |
| issue-creator | 创建人筛选 | string | ✖ |
| issue-mentioned | 提及人筛选 | string | ✖ |
| body-includes | 包含内容筛选 | string | ✖ |
| title-includes | 包含标题筛选 | string | ✖ |
| inactive-day | 非活跃天数筛选 | number | ✖ |
| inactive-label | 新增标签名称 | string | ✖ |
| exclude-labels | 排除标签筛选 | string | ✖ |
- `labels`:为多个时,会查询同时拥有多个。不填时,会查询所有
- `issue-state`:默认为 `all`。可选值 `open` `closed`,非这 2 项时,均为 `all`
- `issue-assignee`:不支持多人。不填或输入 * 时,查询所有。输入 `none` 会查询未添加指定人的 issues
- `inactive-day`:当输入时,会筛选 issue 更新时间早于当前时间减去非活跃天数。不填时,会查询所有
- `inactive-label`:默认为 `inactive`,可自定义其他。当项目未包含该 label 时,会自动新建
## `check-issue`
根据传入的参数和 `issue-number` 来检查该 issue 是否满足条件,返回一个布尔值。
下面的例子效果是:当 issue 新开时,校验当前 issue 指定人是否包含 `x1` 或者 `x2`,满足一个指定人即可校验通过,同时校验标题是否满足条件,[校验规则](/guide/ref#-includes-校验规则)。
```yml
name: Check Issue
on:
issues:
types: [edited]
jobs:
check-issue:
runs-on: ubuntu-latest
steps:
- name: check-issue
uses: actions-cool/issues-helper@v2
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 | ✔ |
| token | [token 说明](/guide/ref#-token-说明) | string | ✔ |
| issue-number | 指定的 issue当不传时会从触发事件中获取 | number | ✖ |
| assignee-includes | 是否包含指定人 | string | ✖ |
| title-includes | 标题包含校验 | string | ✖ |
| title-excludes | 检测标题移除默认 title 后是否为空 | string | ✖ |
| body-includes | 内容包含校验 | string | ✖ |
- `title-includes` `body-includes` 支持格式 `x1,x2` 或者 `x1,x2/y1,y2`。只支持两个层级
- 返回 `check-result`,由于 yml 原因,判断条件为 `if: steps.xxid.outputs.check-result == 'true'`
## `close-issues`
每 7 天 UTC 0 时,关闭已填加 `need info` label 且 7 天以上未活跃的 issues。
```yml
name: Check need info
on:
schedule:
- cron: "0 0 */7 * *"
jobs:
check-need-info:
runs-on: ubuntu-latest
steps:
- name: close-issues
uses: actions-cool/issues-helper@v2
with:
actions: 'close-issues'
token: ${{ secrets.GITHUB_TOKEN }}
labels: 'need info'
inactive-day: 7
```
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/guide/ref#-token-说明) | string | ✔ |
| body | 操作 issue 时,可进行评论。不填时,不评论 | string | ✖ |
| contents | 为该评论增加 [reaction](/guide/ref#-reactions-类型) | string | ✖ |
| labels | 标签筛选 | string | ✖ |
| issue-assignee | 指定人筛选 | string | ✖ |
| issue-creator | 创建人筛选 | string | ✖ |
| issue-mentioned | 提及人筛选 | string | ✖ |
| body-includes | 包含内容筛选 | string | ✖ |
| title-includes | 包含标题筛选 | string | ✖ |
| inactive-day | 非活跃天数筛选 | number | ✖ |
| exclude-labels | 排除标签筛选 | string | ✖ |
- `labels`:为多个时,会查询同时拥有多个。不填时,会查询所有
- `issue-assignee`:不支持多人。不填或输入 * 时,查询所有。输入 `none` 会查询未添加指定人的 issues
- `inactive-day`:当输入时,会筛选 issue 更新时间早于当前时间减去非活跃天数。不填时,会查询所有
## `find-comments`
查找当前仓库 1 号 issue 中,创建者是 k ,内容包含 `this` 的评论列表。
```yml
- name: Find comments
uses: actions-cool/issues-helper@v2
with:
actions: 'find-comments'
token: ${{ secrets.GITHUB_TOKEN }}
issue-number: 1
comment-auth: 'k'
body-includes: 'this'
```
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/guide/ref#-token-说明) | string | ✔ |
| issue-number | 指定的 issue当不传时会从触发事件中获取 | number | ✖ |
| comment-auth | 评论创建者,不填时会查询所有 | string | ✖ |
| body-includes | 评论内容包含过滤,不填时无校验 | string | ✖ |
| direction | 返回 `comments` 排序 | string | ✖ |
- 返回 `comments`,格式如下:
```js
[
{id: 1, auth: 'x', body: 'xxx', created: '', updated: ''},
{id: 2, auth: 'x', body: 'xxx', created: '', updated: ''},
]
```
- `direction` 默认为升序,只有设置 `desc` 时,会返回降序
- 返回数组中 `created` `updated`,由所处环境决定,会是 UTC +0
## `lock-issues`
每 3 个月 1 号 UTC 0 时,锁定已填加 `inactive` label 且 128 天以上未活跃的所有 issues。
```yml
name: Lock inactive issues
on:
schedule:
- cron: "0 0 1 */3 *"
jobs:
lock-issues:
runs-on: ubuntu-latest
steps:
- name: lock-issues
uses: actions-cool/issues-helper@v2
with:
actions: 'lock-issues'
token: ${{ secrets.GITHUB_TOKEN }}
labels: 'inactive'
inactive-day: 128
```
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/guide/ref#-token-说明) | string | ✔ |
| body | 操作 issue 时,可进行评论。不填时,不评论 | string | ✖ |
| contents | 为该评论增加 [reaction](/guide/ref#-reactions-类型) | string | ✖ |
| labels | 标签筛选 | string | ✖ |
| issue-state | 状态筛选 | string | ✖ |
| issue-assignee | 指定人筛选 | string | ✖ |
| issue-creator | 创建人筛选 | string | ✖ |
| issue-mentioned | 提及人筛选 | string | ✖ |
| body-includes | 包含内容筛选 | string | ✖ |
| title-includes | 包含标题筛选 | string | ✖ |
| inactive-day | 非活跃天数筛选 | number | ✖ |
| lock-reason | 锁定 issue 的原因 | string | ✖ |
| exclude-labels | 排除标签筛选 | string | ✖ |
- `labels`:为多个时,会查询同时拥有多个。不填时,会查询所有
- `issue-state`:默认为 `all`。可选值 `open` `closed`,非这 2 项时,均为 `all`
- `issue-assignee`:不支持多人。不填或输入 * 时,查询所有。输入 `none` 会查询未添加指定人的 issues
- `inactive-day`:当输入时,会筛选 issue 更新时间早于当前时间减去非活跃天数。不填时,会查询所有
## `month-statistics`
每月 1 号 1 时,生成一个 issue 上月统计。
```
name: Issue Month Statistics
on:
schedule:
- cron: "0 1 1 * *"
jobs:
month-statistics:
runs-on: ubuntu-latest
steps:
- name: month-statistics
uses: actions-cool/issues-helper@v2
with:
actions: 'month-statistics'
token: ${{ secrets.GITHUB_TOKEN }}
count-lables: 'true'
```
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/guide/ref#-token-说明) | string | ✔ |
| labels | 为新增 issue 添加 labels | string | ✖ |
| assignees | 为新增 issue 添加 assignees | string | ✖ |
| count-lables | 新增 issue 是否统计 labels | string | ✖ |
| count-comments | 新增 issue 是否统计 comments | string | ✖ |
- 新增 `issue` 的标题默认为 `[当前仓库] Month Statistics: 年-月`
- `count-lables`:可设置 `'true'`,增加 labels 统计
- `count-comments`:可设置 `'true'`,增加 comments 统计
如下所示:
![](../public/month.png)

View File

@@ -22,7 +22,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Add assigness
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'add-assignees'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -34,17 +34,16 @@ jobs:
| Param | Desc | Type | Required |
| -- | -- | -- | -- |
| actions | Action type | string | ✔ |
| token | [Token explain](/guide/ref#-token) | string | |
| token | [Token explain](/en-US/guide/ref#-token) | string | |
| issue-number | The number of issue. When not input, it will be obtained from the trigger event | number | ✖ |
| assignees | Designated person. No operation when no input or empty character | string | ✖ |
| random-to | When set, it will be randomly selected in assignees | number | ✖ |
- `actions` support multiple and separated by comma. Like: `add-assignees,add-labels`
- The `name` can be modified according to the actual situation
- [Reference to on](/guide/ref#-github-docs)
- [Reference to on](/en-US/guide/ref#-github-docs)
- `${{ github.event.issue.number }}` is the current issue. [More references](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events)
- `assignees` support multiple and separated by comma
- You can assign up to 10 people to each issue
## `add-labels`
@@ -63,7 +62,7 @@ jobs:
if: contains(github.event.issue.body, 'xxx') == false
steps:
- name: Add labels
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'add-labels'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -74,7 +73,7 @@ jobs:
| Param | Desc | Type | Required |
| -- | -- | -- | -- |
| actions | Action type | string | ✔ |
| token | [Token explain](/guide/ref#-token) | string | |
| token | [Token explain](/en-US/guide/ref#-token) | string | |
| issue-number | The number of issue. When not input, it will be obtained from the trigger event | number | ✖ |
| labels | New labels. When it is not filled in or is empty character, do not add | string | ✖ |
@@ -86,7 +85,7 @@ Close the specified issue.
```yml
- name: Close issue
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'close-issue'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -96,9 +95,8 @@ Close the specified issue.
| Param | Desc | Type | Required |
| -- | -- | -- | -- |
| actions | Action type | string | ✔ |
| token | [Token explain](/guide/ref#-token) | string | |
| token | [Token explain](/en-US/guide/ref#-token) | string | |
| issue-number | The number of issue. When not input, it will be obtained from the trigger event | number | ✖ |
| close-reason | Reason for closing. Default `not_planned`, another `completed` | string | ✖ |
## `create-comment`
@@ -117,7 +115,7 @@ jobs:
if: github.event.label.name == 'xxx'
steps:
- name: Create comment
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'create-comment'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -126,21 +124,22 @@ jobs:
Hello @${{ github.event.issue.user.login }}. Add some comments.
你好 @${{ github.event.issue.user.login }}。巴拉巴拉。
emoji: '+1' or '+1,heart'
contents: '+1' or '+1,heart'
```
| Param | Desc | Type | Required |
| -- | -- | -- | -- |
| actions | Action type | string | ✔ |
| token | [Token explain](/guide/ref#-token) | string | |
| token | [Token explain](/en-US/guide/ref#-token) | string | |
| issue-number | The number of issue. When not input, it will be obtained from the trigger event | number | ✖ |
| body | Add comment content | string | ✖ |
| emoji | Add [emoji](/guide/ref#-emoji-type) | string | ✖ |
| contents | Add [reaction](/en-US/guide/ref#-reactions-type) | string | ✖ |
- No action when `body` is empty
- Return `comment-id`, which can be used for subsequent operations. [Usage reference](/guide/ref#-outputs-use)
- `body` default is `Currently at ${owner}/${repo}. And this is default comment.`
- Where `${owner}/${repo}` means the current repo
- Return `comment-id`, which can be used for subsequent operations. [Usage reference](/en-US/guide/ref#-outputs-use)
- `${{ github.event.issue.user.login }}` indicates the creator of the issue
- `emoji` support multiple and separated by comma
- `contents` support multiple and separated by comma
## `create-issue`
@@ -158,7 +157,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Create issue
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'create-issue'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -166,22 +165,22 @@ jobs:
body: 'xxxx'
labels: 'xx'
assignees: 'xxx'
emoji: '+1'
contents: '+1'
```
| Param | Desc | Type | Required |
| -- | -- | -- | -- |
| actions | Action type | string | ✔ |
| token | [Token explain](/guide/ref#-token) | string | |
| token | [Token explain](/en-US/guide/ref#-token) | string | |
| title | The title of the new issue | string | ✖ |
| body | The body of the new issue | string | ✖ |
| labels | The labels for the new issue | string | ✖ |
| assignees | The assignees for the new issue | string | ✖ |
| random-to | When set, it will be randomly selected in assignees | number | ✖ |
| emoji | Add [emoji](/guide/ref#-emoji-type) | string | ✖ |
| contents | Add [reaction](/en-US/guide/ref#-reactions-type) | string | ✖ |
- `title` default is `Default Title`
- Return `issue-number`. [Usage reference](/guide/ref#-outputs-use)
- Return `issue-number`. [Usage reference](/en-US/guide/ref#-outputs-use)
## `create-label`
@@ -189,7 +188,7 @@ Create label. If you want to maintain labels in batches, [see](https://github.co
```yml
- name: Create label
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'create-label'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -201,7 +200,7 @@ Create label. If you want to maintain labels in batches, [see](https://github.co
| Param | Desc | Type | Required |
| -- | -- | -- | -- |
| actions | Action type | string | ✔ |
| token | [Token explain](/guide/ref#-token) | string | |
| token | [Token explain](/en-US/guide/ref#-token) | string | |
| label-name | Label name, emoji support | string | ✔ |
| label-color | Label color, the format is hexadecimal color code, without `#` | string | ✖ |
| label-desc | Label description | string | ✖ |
@@ -211,11 +210,11 @@ Create label. If you want to maintain labels in batches, [see](https://github.co
## `delete-comment`
According to [`comment-id`](/guide/ref#-comment-id) delete the specified comment.
According to [`comment-id`](/en-US/guide/ref#-comment-id) delete the specified comment.
```yml
- name: Delete comment
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'delete-comment'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -225,27 +224,11 @@ According to [`comment-id`](/guide/ref#-comment-id) delete the specified comment
| Param | Desc | Type | Required |
| -- | -- | -- | -- |
| actions | Action type | string | ✔ |
| token | [Token explain](/guide/ref#-token) | string | |
| token | [Token explain](/en-US/guide/ref#-token) | string | |
| comment-id | The comment ID | number | ✔ |
| out-comments | The output of `find-comments`, if you find multiple, operate multiple | string | ✖ |
## `get-issue`
Query issue information.
```yml
- name: Get Issue
uses: actions-cool/issues-helper@v3
with:
actions: 'get-issue'
token: ${{ secrets.GITHUB_TOKEN }}
```
| Param | Desc | Type | Required |
| -- | -- | -- | -- |
| actions | Action type | string | ✔ |
| token | [Token explain](/guide/ref#-token) | string | ✖ |
- Return `issue-number` `issue-title` `issue-body` `issue-labels` `issue-assignees` `issue-state`. [Usage reference](/guide/ref#-outputs-use)
- When `out-comments` is entered, `comment-id` does not work
## `lock-issue`
@@ -264,7 +247,7 @@ jobs:
if: github.event.label.name == 'invalid'
steps:
- name: Lock issue
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'lock-issue'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -274,19 +257,68 @@ jobs:
| Param | Desc | Type | Required |
| -- | -- | -- | -- |
| actions | Action type | string | ✔ |
| token | [Token explain](/guide/ref#-token) | string | |
| token | [Token explain](/en-US/guide/ref#-token) | string | |
| issue-number | The number of issue. When not input, it will be obtained from the trigger event | number | ✖ |
| lock-reason | Reason for locking issue | string | ✖ |
- `lock-reason`: Optional values are `off-topic` `too heated` `resolved` `spam`
## `mark-duplicate`
Quickly mark duplicate questions, only for issue new comments or edit comments.
```yml
name: Issue Mark Duplicate
on:
issue_comment:
types: [created, edited]
jobs:
mark-duplicate:
runs-on: ubuntu-latest
steps:
- name: mark-duplicate
uses: actions-cool/issues-helper@v2
with:
actions: 'mark-duplicate'
token: ${{ secrets.GITHUB_TOKEN }}
```
| Param | Desc | Type | Required |
| -- | -- | -- | -- |
| actions | Action type | string | ✔ |
| token | [Token explain](/en-US/guide/ref#-token) | string | ✔ |
| duplicate-command | Simple commands can be set, such as: `/d` | string | ✖ |
| duplicate-labels | Add additional labels to this issue | string | ✖ |
| remove-labels | Set removable labels | string | ✖ |
| labels | Replace the labels of the issue | string | ✖ |
| contents | Add [reaction](/en-US/guide/ref#-reactions-type) for this comment | string | ✖ |
| close-issue | Whether to close the issue at the same time | string | ✖ |
| require-permission | Permission required, default is `write` | string | ✖ |
- `duplicate-command`: When setting concise commands, while still supporting the original `Duplicate of`. Block content contains `?`
- `labels`: Highest priority
- `close-issue`: Both `true` or `'true'` can take effect
- `require-permission`: Optional values are `admin`, `write`, `read`, `none`
- If the team member sets the `read` permission, it is `read`
- If the external Collaborator is set to `read` permission, it is `read`
- Ordinary users have `read` permission
- When set `write`, `admin` and `write` meet the conditions
<Alert>
Note: Duplicate created with the concise command does not display the content of the red box in the figure below. But in fact this has no effect.
</Alert>
![](../public/duplicate.png)
## `open-issue`
Open the specified issue.
```yml
- name: Open issue
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'open-issue'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -296,7 +328,7 @@ Open the specified issue.
| Param | Desc | Type | Required |
| -- | -- | -- | -- |
| actions | Action type | string | ✔ |
| token | [Token explain](/guide/ref#-token) | string | |
| token | [Token explain](/en-US/guide/ref#-token) | string | |
| issue-number | The number of issue. When not input, it will be obtained from the trigger event | number | ✖ |
## `remove-assignees`
@@ -305,7 +337,7 @@ Remove the person designated by issue.
```yml
- name: Remove assignees
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'remove-assignees'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -316,7 +348,7 @@ Remove the person designated by issue.
| Param | Desc | Type | Required |
| -- | -- | -- | -- |
| actions | Action type | string | ✔ |
| token | [Token explain](/guide/ref#-token) | string | |
| token | [Token explain](/en-US/guide/ref#-token) | string | |
| issue-number | The number of issue. When not input, it will be obtained from the trigger event | number | ✖ |
| assignees | Designated person removed. When it is an empty character, do not remove | string | ✔ |
@@ -326,7 +358,7 @@ Remove the specified labels.
```yml
- name: Remove labels
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'remove-labels'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -337,7 +369,7 @@ Remove the specified labels.
| Param | Desc | Type | Required |
| -- | -- | -- | -- |
| actions | Action type | string | ✔ |
| token | [Token explain](/guide/ref#-token) | string | |
| token | [Token explain](/en-US/guide/ref#-token) | string | |
| issue-number | The number of issue. When not input, it will be obtained from the trigger event | number | ✖ |
| labels | The removed labels. When it is a blank character, do not remove | string | ✔ |
@@ -349,7 +381,7 @@ Replace the labels of issue.
```yml
- name: Set labels
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'set-labels'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -360,7 +392,7 @@ Replace the labels of issue.
| Param | Desc | Type | Required |
| -- | -- | -- | -- |
| actions | Action type | string | ✔ |
| token | [Token explain](/guide/ref#-token) | string | |
| token | [Token explain](/en-US/guide/ref#-token) | string | |
| issue-number | The number of issue. When not input, it will be obtained from the trigger event | number | ✖ |
| labels | labels set. When empty characters, will remove all | string | ✔ |
@@ -370,7 +402,7 @@ Unlock the specified issue.
```yml
- name: Unlock issue
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'unlock-issue'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -380,12 +412,12 @@ Unlock the specified issue.
| Param | Desc | Type | Required |
| -- | -- | -- | -- |
| actions | Action type | string | ✔ |
| token | [Token explain](/guide/ref#-token) | string | |
| token | [Token explain](/en-US/guide/ref#-token) | string | |
| issue-number | The number of issue. When not input, it will be obtained from the trigger event | number | ✖ |
## `update-comment`
Update the specified comment according to [`comment-id`](/guide/ref#-comment-id).
Update the specified comment according to [`comment-id`](/en-US/guide/ref#-comment-id).
The following example shows that 👀 is added for each new comment.
@@ -401,23 +433,23 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Update comment
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'update-comment'
token: ${{ secrets.GITHUB_TOKEN }}
comment-id: ${{ github.event.comment.id }}
emoji: 'eyes'
contents: 'eyes'
```
| Param | Desc | Type | Required |
| -- | -- | -- | -- |
| actions | Action type | string | ✔ |
| token | [Token explain](/guide/ref#-token) | string | |
| token | [Token explain](/en-US/guide/ref#-token) | string | |
| comment-id | The comment ID | number | ✔ |
| out-comments | The output of `find-comments`, if you find multiple, operate multiple | string | ✖ |
| body | Update the content of comment | string | ✖ |
| update-mode | Update mode. Default `replace`, another `append` | string | ✖ |
| emoji | Add [emoji](/guide/ref#-emoji-type) | string | ✖ |
| contents | Add [reaction](/en-US/guide/ref#-reactions-type) | string | ✖ |
- When `body` is not entered, it will remain as it is
- When `update-mode` is `append`, additional operations will be performed. Anything other than `append` will be replaced. Only effective for `body`
@@ -429,7 +461,7 @@ Update the specified issue according to the `issue-number`.
```yml
- name: Update issue
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'update-issue'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -440,13 +472,13 @@ Update the specified issue according to the `issue-number`.
update-mode: 'replace'
labels: 'xx'
assignees: 'xxx'
emoji: '+1'
contents: '+1'
```
| Param | Desc | Type | Required |
| -- | -- | -- | -- |
| actions | Action type | string | ✔ |
| token | [Token explain](/guide/ref#-token) | string | |
| token | [Token explain](/en-US/guide/ref#-token) | string | |
| issue-number | The number of issue. When not input, it will be obtained from the trigger event | number | ✖ |
| state | Modify the status of issue, optional value `open` `closed` | string | ✖ |
| title | Modify the title of the issue | string | ✖ |
@@ -454,7 +486,46 @@ Update the specified issue according to the `issue-number`.
| update-mode | Update mode. Default `replace`, another `append` | string | ✖ |
| labels | Replace the labels of issue | string | ✖ |
| assignees | Replace the assignees of issue | string | ✖ |
| emoji | Add [emoji](/guide/ref#-emoji-type) | string | ✖ |
| contents | Add [reaction](/en-US/guide/ref#-reactions-type) | string | ✖ |
- `state` defaults to `open`
- When the option is not filled, it will keep the original
## `welcome`
When an issue is created, the user who created the issue for the first time is welcome.
If the user is not creating for the first time, there is no operation.
```yml
name: Issue Welcome
on:
issues:
types: [opened]
jobs:
issue-welcome:
runs-on: ubuntu-latest
steps:
- name: welcome
uses: actions-cool/issues-helper@v2
with:
actions: 'welcome'
token: ${{ secrets.GITHUB_TOKEN }}
body: hi @${{ github.event.issue.user.login }}, welcome!
labels: 'welcome1, welcome2'
assignees: 'xx1'
issue-contents: '+1, -1, eyes'
```
| Param | Desc | Type | Required |
| -- | -- | -- | -- |
| actions | Action type | string | ✔ |
| token | [Token explain](/en-US/guide/ref#-token) | string | ✔ |
| body | Comment on the welcome content, no comment if you leave it blank | string | ✖ |
| labels | Add labels to this issue | string | ✖ |
| assignees | Add assignees to this issue | string | ✖ |
| issue-contents | Add [reaction](/en-US/guide/ref#-reactions-type) to this issue| string | ✖ |
- If these 4 options are not filled, no operation

View File

@@ -22,7 +22,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Add assigness
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'add-assignees'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -34,17 +34,16 @@ jobs:
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/zh-CN/guide/ref#-token-说明) | string | |
| token | [token 说明](/guide/ref#-token-说明) | string | |
| issue-number | 指定的 issue当不传时会从触发事件中获取 | number | ✖ |
| assignees | 指定人。当不填或者为空字符时,不操作 | string | ✖ |
| random-to | 当设置时,会在 assignees 中随机选择 | number | ✖ |
- `actions` 支持多个,需用逗号隔开。如:`add-assignees,add-labels`
- 其中的 `name` 可根据自行根据实际情况修改
- [on 参考](/zh-CN/guide/ref#-github-相关文档)
- [on 参考](/guide/ref#-github-相关文档)
- `${{ github.event.issue.number }}` 表示当前 issue[更多参考](https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events)
- `assignees` 支持多个,需用逗号隔开
- assign 最多只能设定 10 个
## `add-labels`
@@ -63,7 +62,7 @@ jobs:
if: contains(github.event.issue.body, 'xxx') == false
steps:
- name: Add labels
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'add-labels'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -74,7 +73,7 @@ jobs:
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/zh-CN/guide/ref#-token-说明) | string | |
| token | [token 说明](/guide/ref#-token-说明) | string | |
| issue-number | 指定的 issue当不传时会从触发事件中获取 | number | ✖ |
| labels | 新增的 labels。当不填或者为空字符时不新增 | string | ✖ |
@@ -86,7 +85,7 @@ jobs:
```yml
- name: Close issue
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'close-issue'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -96,9 +95,8 @@ jobs:
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/zh-CN/guide/ref#-token-说明) | string | |
| token | [token 说明](/guide/ref#-token-说明) | string | |
| issue-number | 指定的 issue当不传时会从触发事件中获取 | number | ✖ |
| close-reason | 关闭原因。默认`not_planned`未计划,`completed`完成 | string | ✖ |
## `create-comment`
@@ -117,7 +115,7 @@ jobs:
if: github.event.label.name == 'xxx'
steps:
- name: Create comment
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'create-comment'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -126,21 +124,22 @@ jobs:
Hello ${{ github.event.issue.user.login }}. Add some comments.
你好 ${{ github.event.issue.user.login }}。巴拉巴拉。
emoji: '+1' or '+1,heart'
contents: '+1' or '+1,heart'
```
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/zh-CN/guide/ref#-token-说明) | string | |
| token | [token 说明](/guide/ref#-token-说明) | string | |
| issue-number | 指定的 issue当不传时会从触发事件中获取 | number | ✖ |
| body | 新增评论的内容 | string | ✖ |
| emoji | 为新增评论的增加 [emoji](/zh-CN/guide/ref#-emoji-类型) | string | ✖ |
| contents | 为新增评论的增加 [reaction](/guide/ref#-reactions-类型) | string | ✖ |
- `body` 为空时,无操作
- 返回 `comment-id`,可用于之后操作。[用法参考](/zh-CN/guide/ref#-outputs-使用)
- `body` 默认为:`Currently at ${owner}/${repo}. And this is default comment.`
- 其中 `${owner}/${repo}` 表示当前仓库
- 返回 `comment-id`,可用于之后操作。[用法参考](/guide/ref#-outputs-使用)
- `${{ github.event.issue.user.login }}` 表示该 issue 的创建者
- `emoji` 支持多个,需用逗号隔开
- `contents` 支持多个,需用逗号隔开
## `create-issue`
@@ -158,7 +157,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Create issue
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'create-issue'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -166,22 +165,22 @@ jobs:
body: 'xxxx'
labels: 'xx'
assignees: 'xxx'
emoji: '+1'
contents: '+1'
```
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/zh-CN/guide/ref#-token-说明) | string | |
| token | [token 说明](/guide/ref#-token-说明) | string | |
| title | 新增 issue 的标题 | string | ✖ |
| body | 新增 issue 的内容 | string | ✖ |
| labels | 为新增 issue 添加 labels | string | ✖ |
| assignees | 为新增 issue 添加 assignees | string | ✖ |
| random-to | 当设置时,会在 assignees 中随机选择 | number | ✖ |
| emoji | 为新增 issue 增加 [emoji](/zh-CN/guide/ref#-emoji-类型) | string | ✖ |
| contents | 为新增 issue 增加 [reaction](/guide/ref#-reactions-类型) | string | ✖ |
- `title` 默认为:`Default Title`
- 返回 `issue-number`[用法参考](/zh-CN/guide/ref#-outputs-使用)
- 返回 `issue-number`[用法参考](/guide/ref#-outputs-使用)
## `create-label`
@@ -189,7 +188,7 @@ jobs:
```yml
- name: Create label
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'create-label'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -201,7 +200,7 @@ jobs:
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/zh-CN/guide/ref#-token-说明) | string | |
| token | [token 说明](/guide/ref#-token-说明) | string | |
| label-name | 标签名称,支持 emoji | string | ✔ |
| label-color | 标签颜色,格式为 16 进制色码,不加 `#` | string | ✖ |
| label-desc | 标签描述 | string | ✖ |
@@ -211,11 +210,11 @@ jobs:
## `delete-comment`
根据 [`comment-id`](/zh-CN/guide/ref#-comment-id) 删除指定评论。
根据 [`comment-id`](/guide/ref#-comment-id) 删除指定评论。
```yml
- name: Delete comment
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'delete-comment'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -225,27 +224,11 @@ jobs:
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/zh-CN/guide/ref#-token-说明) | string | |
| token | [token 说明](/guide/ref#-token-说明) | string | |
| comment-id | 指定的 comment | number | ✔ |
| out-comments | `find-comments` 的输出,若查找多个,则操作多个 | string | ✖ |
## `get-issue`
查询 issue 信息。
```yml
- name: Get Issue
uses: actions-cool/issues-helper@v3
with:
actions: 'get-issue'
token: ${{ secrets.GITHUB_TOKEN }}
```
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/zh-CN/guide/ref#-token-说明) | string | ✖ |
- 返回 `issue-number` `issue-title` `issue-body` `issue-labels` `issue-assignees` `issue-state`[用法参考](/zh-CN/guide/ref#-outputs-使用)
- 当 `out-comments` 输入时,`comment-id` 不起作用
## `lock-issue`
@@ -264,7 +247,7 @@ jobs:
if: github.event.label.name == 'invalid'
steps:
- name: Lock issue
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'lock-issue'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -274,19 +257,68 @@ jobs:
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/zh-CN/guide/ref#-token-说明) | string | |
| token | [token 说明](/guide/ref#-token-说明) | string | |
| issue-number | 指定的 issue当不传时会从触发事件中获取 | number | ✖ |
| lock-reason | 锁定 issue 的原因 | string | ✖ |
- `lock-reason`:可选值有 `off-topic` `too heated` `resolved` `spam`
## `mark-duplicate`
快捷标记重复问题,仅作用于 issue 新增编辑评论。
```yml
name: Issue Mark Duplicate
on:
issue_comment:
types: [created, edited]
jobs:
mark-duplicate:
runs-on: ubuntu-latest
steps:
- name: mark-duplicate
uses: actions-cool/issues-helper@v2
with:
actions: 'mark-duplicate'
token: ${{ secrets.GITHUB_TOKEN }}
```
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/guide/ref#-token-说明) | string | ✔ |
| duplicate-command | 可设置简洁命令,如:`/d` | string | ✖ |
| duplicate-labels | 为该 issue 额外增加 labels | string | ✖ |
| remove-labels | 设置可移除的 labels | string | ✖ |
| labels | 替换该 issue 的 labels | string | ✖ |
| contents | 为该评论的增加 [reaction](/guide/ref#-reactions-类型) | string | ✖ |
| close-issue | 是否同时关闭该 issue | string | ✖ |
| require-permission | 要求权限,默认为 `write` | string | ✖ |
- `duplicate-command`:当设置简洁命令时,同时仍支持原有 `Duplicate of`。屏蔽内容包含 `?`
- `labels`:优先级最高
- `close-issue``true``'true'` 均可生效
- `require-permission`:可选值有 `admin``write``read``none`
- 团队成员若设置 `read` 权限,则为 `read`
- 外部 Collaborator 若设置 `read` 权限,则为 `read`
- 普通用户为 `read` 权限
- 当设置 `write` 后,`admin``write` 满足条件
<Alert>
注意:使用简洁命令创建的 Duplicate 不显示下图红框内容。但其实这个没有任何影响的。
</Alert>
![](../public/duplicate.png)
## `open-issue`
打开指定 issue。
```yml
- name: Open issue
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'open-issue'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -296,7 +328,7 @@ jobs:
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/zh-CN/guide/ref#-token-说明) | string | |
| token | [token 说明](/guide/ref#-token-说明) | string | |
| issue-number | 指定的 issue当不传时会从触发事件中获取 | number | ✖ |
## `remove-assignees`
@@ -305,7 +337,7 @@ jobs:
```yml
- name: Remove assignees
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'remove-assignees'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -316,7 +348,7 @@ jobs:
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/zh-CN/guide/ref#-token-说明) | string | |
| token | [token 说明](/guide/ref#-token-说明) | string | |
| issue-number | 指定的 issue当不传时会从触发事件中获取 | number | ✖ |
| assignees | 移除的指定人。当为空字符时,不进行移除 | string | ✔ |
@@ -326,7 +358,7 @@ jobs:
```yml
- name: Remove labels
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'remove-labels'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -337,7 +369,7 @@ jobs:
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/zh-CN/guide/ref#-token-说明) | string | |
| token | [token 说明](/guide/ref#-token-说明) | string | |
| issue-number | 指定的 issue当不传时会从触发事件中获取 | number | ✖ |
| labels | 移除的 labels。当为空字符时不进行移除 | string | ✔ |
@@ -349,7 +381,7 @@ jobs:
```yml
- name: Set labels
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'set-labels'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -360,7 +392,7 @@ jobs:
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/zh-CN/guide/ref#-token-说明) | string | |
| token | [token 说明](/guide/ref#-token-说明) | string | |
| issue-number | 指定的 issue当不传时会从触发事件中获取 | number | ✖ |
| labels | labels 设置。当空字符时,会移除所有 | string | ✔ |
@@ -370,7 +402,7 @@ jobs:
```yml
- name: Unlock issue
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'unlock-issue'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -380,12 +412,12 @@ jobs:
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/zh-CN/guide/ref#-token-说明) | string | |
| token | [token 说明](/guide/ref#-token-说明) | string | |
| issue-number | 指定的 issue当不传时会从触发事件中获取 | number | ✖ |
## `update-comment`
根据 [`comment-id`](/zh-CN/guide/ref#-comment-id) 更新指定评论。
根据 [`comment-id`](/guide/ref#-comment-id) 更新指定评论。
下面的例子展示的是,为每个新增的 comment 增加 👀 。
@@ -401,23 +433,23 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Update comment
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'update-comment'
token: ${{ secrets.GITHUB_TOKEN }}
comment-id: ${{ github.event.comment.id }}
emoji: 'eyes'
contents: 'eyes'
```
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/zh-CN/guide/ref#-token-说明) | string | |
| token | [token 说明](/guide/ref#-token-说明) | string | |
| comment-id | 指定的 comment | number | ✔ |
| out-comments | `find-comments` 的输出,若查找多个,则操作多个 | string | ✖ |
| body | 更新 comment 的内容 | string | ✖ |
| update-mode | 更新模式。默认 `replace` 替换,`append` 附加 | string | ✖ |
| emoji | 增加 [emoji](/zh-CN/guide/ref#-emoji-类型) | string | ✖ |
| contents | 增加 [reaction](/guide/ref#-reactions-类型) | string | ✖ |
- `body` 不填时,会保持原有
- `update-mode``append` 时,会进行附加操作。非 `append` 都会进行替换。仅对 `body` 生效
@@ -429,7 +461,7 @@ jobs:
```yml
- name: Update issue
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'update-issue'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -440,13 +472,13 @@ jobs:
update-mode: 'replace'
labels: 'xx'
assignees: 'xxx'
emoji: '+1'
contents: '+1'
```
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/zh-CN/guide/ref#-token-说明) | string | |
| token | [token 说明](/guide/ref#-token-说明) | string | |
| issue-number | 指定的 issue当不传时会从触发事件中获取 | number | ✖ |
| state | 修改 issue 的状态,可选值 `open` `closed` | string | ✖ |
| title | 修改 issue 的标题 | string | ✖ |
@@ -454,7 +486,45 @@ jobs:
| update-mode | 更新模式。默认 `replace` 替换,`append` 附加 | string | ✖ |
| labels | 替换 issue 的 labels | string | ✖ |
| assignees | 替换 issue 的 assignees | string | ✖ |
| emoji | 增加 [emoji](/zh-CN/guide/ref#-emoji-类型) | string | ✖ |
| contents | 增加 [reaction](/guide/ref#-reactions-类型) | string | ✖ |
- `state` 默认为 `open`
- 当可选项不填时,会保持原有
## `welcome`
当一个 issue 新建时,对首次新建 issue 的用户进行欢迎。若用户非首次新建,则无操作。
```yml
name: Issue Welcome
on:
issues:
types: [opened]
jobs:
issue-welcome:
runs-on: ubuntu-latest
steps:
- name: welcome
uses: actions-cool/issues-helper@v2
with:
actions: 'welcome'
token: ${{ secrets.GITHUB_TOKEN }}
body: hi @${{ github.event.issue.user.login }}, welcome!
labels: 'welcome1, welcome2'
assignees: 'xx1'
issue-contents: '+1, -1, eyes'
```
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/guide/ref#-token-说明) | string | ✔ |
| body | 评论欢迎的内容,不填则不评论 | string | ✖ |
| labels | 为该 issue 增加 labels | string | ✖ |
| assignees | 为该 issue 增加 assignees | string | ✖ |
| issue-contents | 为该 issue 增加 [reaction](/guide/ref#-reactions-类型) | string | ✖ |
- 若这 4 个可选项都不填,则无操作

38
docs/changelog.en-US.md Normal file
View File

@@ -0,0 +1,38 @@
---
toc: menu
---
# ✨ 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 or undergoes refactoring, release the advanced v2.x version
- After the v2 version, the version will be released strictly according to the three-level semantics, such as v2.0.0, v2.1.0
- 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
- The latest v1.x release code will be merged into the 1.x branch
- After the v2 version, the v2 tag is supported, and the latest 2.x code will be synchronized
- It also supports the direct use of branch versions. Such as:
```yml
- name: Issues Helper
uses: actions-cool/issues-helper@main
# or
- name: Issues Helper
uses: actions-cool/issues-helper@1.x
# or
- name: Issues Helper
uses: actions-cool/issues-helper@v2
```
- v2 [upgrade reference](/en-US/guide/faq)
<embed src="../CHANGELOG.md"></embed>

38
docs/changelog.md Normal file
View File

@@ -0,0 +1,38 @@
---
toc: menu
---
# ✨ 更新日志
- 版本规则
- 采用两级语义化版本如v1、v1.1、v2、v2.1
- v1 表示初始版本
- 对 v1 版本的修复和新增会发布到 v1.1 版本
- 当发布的 v1.x 运行一定时间稳定或进行重构时,发布进阶 v2.x 版本
- v2 版本后会严格按照三级语义来发布版本,如 v2.0.0、v2.1.0
- 版本选择
- 建议采用最新 releases 版本。可在 [releases](https://github.com/actions-cool/issues-helper/releases) 看到
- 同时也可参照下面的更新日志来选择版本
- 最新的 v1.x release 代码会合并到 1.x 分支中
- v2 版本后支持使用 v2 tag将同步最新 2.x 代码
- 支持直接使用分支版本。如:
```yml
- name: Issues Helper
uses: actions-cool/issues-helper@main
# or
- name: Issues Helper
uses: actions-cool/issues-helper@1.x
# or
- name: Issues Helper
uses: actions-cool/issues-helper@v2
```
- v2 [升级参考](/guide/faq)
<embed src="../CHANGELOG.md"></embed>

35
docs/guide/faq.en-US.md Normal file
View File

@@ -0,0 +1,35 @@
---
toc: menu
---
## Is there a charge for this feature?
GitHub Actions is provided free of charge by GitHub. Among them, the `Private` project has a monthly limit of 2000 times, [see details](https://github.com/settings/billing). The `Public` project is unlimited.
### Is there a rate limit?
Yes. The bottom layer of Action uses GitHub REST API. The general situation is 5000 times per hour. It is basically sufficient in principle, and it is also required to avoid invalid requests when defining Action. [Detailed view](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting).
## Are there any ready-made templates for reference?
Yes.
1. You can use this [GitHub Actions workflow template](https://github.com/actions-cool/.github) repository template
2. Personal exercises and tests [Actions](https://github.com/actions-cool/test-issues-helper) repository
3. You can also refer to the warehouse of [online users](/en-US#-who-is-using)
## I want to pause Actions, is there an easy way?
Yes, you can directly modify `actions`. For example: `actions:'create-comment'` is changed to `actions:'#create-comment'`. It is also convenient for recovery.
## So many versions, how to choose?
You can view the detailed [changelog](/en-US/changelog). The latest releases version is recommended.
## What should I pay attention to when upgrading from v1.x to v2?
There is only one difference between v1.12 and v2.0.0. That is, `require-permission` in `mark-duplicate` has added the default value `write`.
## What should I do if there is no function I want here?
You can submit it in [What do you want?](https://github.com/actions-cool/issues-helper/discussions/18).

35
docs/guide/faq.md Normal file
View File

@@ -0,0 +1,35 @@
---
toc: menu
---
## 该功能是否收费?
GitHub Actions 是由 GitHub 免费提供的。其中 `Private` 项目每月有 2000 次的限制,[具体查看](https://github.com/settings/billing)。`Public` 项目无限制。
### 有没有速率的限制?
有的。Action 底层使用的是 GitHub REST API。一般情况是每小时 5000 次。原则上基本是够用的,同时也要求在 Action 定义时,尽量避免无效的请求。[具体查看](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting)。
## 有没有现成的模板可以参考?
有的。
1. 你可以使用这个 [GitHub Actions workflow template](https://github.com/actions-cool/.github) 仓库的模板
2. 个人练习和测试 [Actions](https://github.com/actions-cool/test-issues-helper) 的仓库
3. 也可以来 [线上使用者](/#-谁在使用?) 的仓库参照
## 我想暂停 Actions有没有简单的办法
有的,你可以将直接修改 `actions`。例如:`actions: 'create-comment'` 修改为 `actions: '#create-comment'`。同时也方便恢复。
## 这么多版本,如何选择?
你可以查看详细的 [更新日志](/changelog)。推荐采用最新 releases 版本。
## 从 v1.x 升级到 v2有什么注意的地方吗
v1.12 和 v2.0.0 版本的差别只有一处。即 `mark-duplicate` 中的 `require-permission` 增加了默认值 `write`
## 如果这里没有我想要的功能,该怎么办?
你可以在 [What do you want?](https://github.com/actions-cool/issues-helper/discussions/18) 中提出。

View File

@@ -44,7 +44,6 @@ ref: [GitHub docs](https://docs.github.com/en/actions/reference/events-that-trig
- The owner or collaborator of the warehouse, if there is an organization, including members
- Participants of the issue, including creators and commenters
- Max 10
## Benchmark

View File

@@ -45,7 +45,6 @@ ref: [GitHub docs](https://docs.github.com/en/actions/reference/events-that-trig
- 仓库的所有者或协作者,若有组织,包括成员
- issue 的参与者,包括创建者、评论者
- 最多支持 10 个
## 运行基准

View File

@@ -66,7 +66,7 @@ x2 + y2
"x1" false
```
## 📍 `emoji` Type
## 📍 `Reactions` Type
| content | emoji |
| -- | -- |

View File

@@ -66,7 +66,7 @@ x2 + y2
"x1" false
```
## 📍 `emoji` 类型
## 📍 `Reactions` 类型
| content | emoji |
| -- | -- |

View File

@@ -4,11 +4,11 @@
Click Actions in the warehouse, if Actions have been added, the following interface will be displayed.
![](https://gw.alipayobjects.com/mdn/rms_f97235/afts/img/A*D5dMQLk2pI0AAAAAAAAAAAAAARQnAQ)
![](../../public/add-1.jpg)
Click `New workflow` to add.
![](https://gw.alipayobjects.com/mdn/rms_f97235/afts/img/A*cClPRIW6HKcAAAAAAAAAAAAAARQnAQ)
![](../../public/add-2.jpg)
<Alert type="success">
You can click <Badge>set up a workflow yourself</Badge> to add a custom action, or you can apply a new action based on a template. <a target="_blank" href="https://github.com/actions-cool/.github">Templates</a>.
@@ -33,7 +33,7 @@ jobs:
steps:
- name: help wanted
if: github.event.label.name == 'help wanted'
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2.0.0
with:
actions: 'create-comment'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -44,18 +44,18 @@ jobs:
你好 @${{ github.event.issue.user.login }},我们完全同意你的提议/反馈欢迎PR。
```
- `YML` syntax reference
- [Workflow syntax for GitHub Actions](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#about-yaml-syntax-for-workflows)
- [Workflow syntax for GitHub Actions](https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#on)
- `name`: The workflow name
- Actions workflow name, can be customized according to actual situation
- `on`: The action trigger condition
- Reference [Events that trigger workflows](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows)
- Reference [Events that trigger workflows](https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows)
- `uses`: Use actions name
- `uses: actions-cool/issues-helper@v2.0.0`。Please [refer](/changelog) to version selection
- `uses: actions-cool/issues-helper@v2.0.0`。Please [refer](/en-US/changelog) to version selection
- `issues-hepler` parameter
- `actions`: The name of the function used, **required**. Support multiple, separated by commas, such as `create-comment,close-issue` means comment and close issue
- `token`: A person who needs to have push permission token
- [More view](/guide/ref#-token)
- `issue-number`: Incoming parameter, here means the number of the current issue. If you are confused about the writing, you can [view](https://docs.github.com/en/actions/learn-github-actions/contexts#github-context)
- [More view](/en-US/guide/ref#-token)
- `issue-number`: Incoming parameter, here means the number of the current issue. If you are confused about the writing, you can [view](https://docs.github.com/en/free-pro-team@latest/actions/reference/context-and-expression-syntax-for-github-actions#github-context)
- `body`: Incoming parameters, here means the content of the current comment
### 3. Enable Action
@@ -64,4 +64,4 @@ When you finish writing and submit to the master branch, you can automatically e
😏 I believe that you have a general understanding of `how to use`, do you want to try it quickly?
Please check the functions you need in [Basic](/base) and [Advanced](/advanced) for flexible reference.
Please check the functions you need in [Basic](/en-US/base) and [Advanced](/en-US/advanced) for flexible reference.

View File

@@ -4,11 +4,11 @@
点击仓库的 Actions若已增加过 Actions会显示如下界面。
![](https://gw.alipayobjects.com/mdn/rms_f97235/afts/img/A*D5dMQLk2pI0AAAAAAAAAAAAAARQnAQ)
![](../../public/add-1.jpg)
点击 `New workflow` 新增。
![](https://gw.alipayobjects.com/mdn/rms_f97235/afts/img/A*cClPRIW6HKcAAAAAAAAAAAAAARQnAQ)
![](../../public/add-2.jpg)
<Alert type="success">
你可以点击 <Badge>set up a workflow yourself</Badge> 新增一个自定义 action也可以根据模板来套用新增一个 action。<a target="_blank" href="https://github.com/actions-cool/.github">模板使用</a>
@@ -33,7 +33,7 @@ jobs:
steps:
- name: help wanted
if: github.event.label.name == 'help wanted'
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2.0.0
with:
actions: 'create-comment'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -44,18 +44,18 @@ jobs:
你好 @${{ github.event.issue.user.login }},我们完全同意你的提议/反馈欢迎PR。
```
- `YML` 语法参考
- [GitHub Actions 语法](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#about-yaml-syntax-for-workflows)
- [GitHub Actions 语法](https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#on)
- `name`workflow 名称
- Actions 流程名称,可根据实际情况自定义
- `on`action 触发条件
- 参考 [工作流触发机制](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows)
- 参考 [工作流触发机制](https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows)
- `uses`:使用 actions 名称
- `uses: actions-cool/issues-helper@v2.0.0`。版本选择请 [参考](/zh-CN/changelog)
- `uses: actions-cool/issues-helper@v2.0.0`。版本选择请 [参考](/changelog)
- `issues-hepler` 参数
- `actions`:使用功能的名称,**必填**。支持多个,需用逗号隔开,如 `create-comment,close-issue` 表示评论和关闭 issue
- `token`:需拥有 push 权限的人员 token
- 更多 [参考](/zh-CN/guide/ref#-token-说明)
- `issue-number`:传入参数,这里表示当前 issue 的编号。如果你对写法疑惑,可 [查看](https://docs.github.com/en/actions/learn-github-actions/contexts#github-context)
- 更多 [参考](/guide/ref#-token-说明)
- `issue-number`:传入参数,这里表示当前 issue 的编号。如果你对写法疑惑,可 [查看](https://docs.github.com/en/free-pro-team@latest/actions/reference/context-and-expression-syntax-for-github-actions#github-context)
- `body`:传入参数,这里表示当前进行评论的内容
### 3. 启用 Action
@@ -64,4 +64,4 @@ jobs:
😏 相信到这里你已经对 `如何使用` 有了大概的了解,是不是想快点尝试一下。
下面请在 [基 础](/zh-CN/base) 和 [进 阶](/zh-CN/advanced) 查看你需要的功能,灵活参考。
下面请在 [基 础](/base) 和 [进 阶](/advanced) 查看你需要的功能,灵活参考。

View File

@@ -3,19 +3,19 @@ title: Issues Helper
order: 1
hero:
title: Issues Helper
image: https://gw.alipayobjects.com/mdn/rms_f97235/afts/img/A*8xDgSL-O6O4AAAAAAAAAAAAAARQnAQ
image: https://avatars1.githubusercontent.com/u/73879334?s=200&v=4
desc: 🤖 A GitHub Action that easily helps you automatically manage issues
actions:
- text: Quick start
link: /guide/start
link: /en-US/guide/start
features:
- icon: https://gw.alipayobjects.com/mdn/rms_f97235/afts/img/A*Km0BQJs7vWAAAAAAAAAAAAAAARQnAQ
- icon: https://github.com/actions-cool/resources/blob/main/image/free.png?raw=true
title: Completely free
desc: Use the Actions service provided by GitHub
- icon: https://gw.alipayobjects.com/mdn/rms_f97235/afts/img/A*ELKWSIMizH0AAAAAAAAAAAAAARQnAQ
- icon: https://github.com/actions-cool/resources/blob/main/image/snap.png?raw=true
title: Easy to use
desc: Detailed tutorials and rich templates
- icon: https://gw.alipayobjects.com/mdn/rms_f97235/afts/img/A*j-SURo-DkyIAAAAAAAAAAAAAARQnAQ
- icon: https://github.com/actions-cool/resources/blob/main/image/network.png?raw=true
title: Easy hosting
desc: As long as GitHub is not down, it will not be affected
footer: Open-source MIT Licensed | Copyright © 2020-present<br />Powered by xrkffgg
@@ -38,7 +38,7 @@ jobs:
steps:
- name: help wanted
if: github.event.label.name == 'help wanted'
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'create-comment'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -51,7 +51,7 @@ jobs:
## 💖 Who is using?
<embed src="../../README.md#RE-/<table>[^]+?[\r\n]<\/table>/"></embed>
<embed src="../README.md#RE-/<table>[^]+?[\r\n]<\/table>/"></embed>
## ⚡ Feedback

View File

@@ -3,19 +3,19 @@ title: Issues 助手
order: 1
hero:
title: Issues 助手
image: https://gw.alipayobjects.com/mdn/rms_f97235/afts/img/A*8xDgSL-O6O4AAAAAAAAAAAAAARQnAQ
image: https://avatars1.githubusercontent.com/u/73879334?s=200&v=4
desc: 🤖 一个轻松帮你自动管理 issues 的 GitHub Action
actions:
- text: 快速开始
link: /zh-CN/guide/start
link: /guide/start
features:
- icon: https://gw.alipayobjects.com/mdn/rms_f97235/afts/img/A*Km0BQJs7vWAAAAAAAAAAAAAAARQnAQ
- icon: https://github.com/actions-cool/resources/blob/main/image/free.png?raw=true
title: 完全免费
desc: 使用 GitHub 自带提供的 Actions 服务
- icon: https://gw.alipayobjects.com/mdn/rms_f97235/afts/img/A*ELKWSIMizH0AAAAAAAAAAAAAARQnAQ
- icon: https://github.com/actions-cool/resources/blob/main/image/snap.png?raw=true
title: 简单易用
desc: 教程详细,模版丰富
- icon: https://gw.alipayobjects.com/mdn/rms_f97235/afts/img/A*j-SURo-DkyIAAAAAAAAAAAAAARQnAQ
- icon: https://github.com/actions-cool/resources/blob/main/image/network.png?raw=true
title: 轻松托管
desc: 只要 GitHub 不宕机,它就不受影响
footer: Open-source MIT Licensed | Copyright © 2020-present<br />Powered by xrkffgg
@@ -38,7 +38,7 @@ jobs:
steps:
- name: help wanted
if: github.event.label.name == 'help wanted'
uses: actions-cool/issues-helper@v3
uses: actions-cool/issues-helper@v2
with:
actions: 'create-comment'
token: ${{ secrets.GITHUB_TOKEN }}
@@ -51,7 +51,7 @@ jobs:
## 💖 谁在使用?
<embed src="../../README.md#RE-/<table>[^]+?[\r\n]<\/table>/"></embed>
<embed src="../README.md#RE-/<table>[^]+?[\r\n]<\/table>/"></embed>
## ⚡ 反馈
@@ -63,4 +63,4 @@ jobs:
也欢迎加入 钉钉交流群
![](https://gw.alipayobjects.com/mdn/rms_f97235/afts/img/A*-iuDSpF7QAQAAAAAAAAAAAAAARQnAQ)
![](https://github.com/actions-cool/resources/blob/main/dingding.jpeg?raw=true)

View File

@@ -1,10 +1,3 @@
// main
html {
scroll-behavior: smooth;
-webkit-overflow-scrolling: touch;
}
// dumi
.__dumi-default-code-block {
background-color: rgba(0, 0, 0, 0.04) !important;
border-radius: 4px;
@@ -15,15 +8,6 @@ html {
}
}
.__dumi-default-navbar {
background: rgba(255, 255, 255, 0.8) !important;
backdrop-filter: blur(20px);
[data-prefers-color=dark] & {
background: rgba(0, 0, 0, 0.8) !important;
}
}
.__dumi-default-menu {
box-shadow: 0 6px 20px 2px rgba(0, 0, 0, 0.08);
}
@@ -40,16 +24,10 @@ html {
button {
margin-right: 0 !important;
background: radial-gradient(100% 100% at 100% 0%,
#5ADAFF 0%,
#1890ff 100%) !important;
box-shadow: 0px 2px 4px rgba(45,35,66, 40%), 0px 7px 13px -3px rgba(45, 35, 66, 30%), inset 0px -3px 0px rgba(58, 65, 111, 50%) !important;
background: linear-gradient(45deg,#72a2de 30%,#5db8c7 90%) !important;
border: none !important;
border-radius: 8px !important;
text-align: center;
text-shadow: 0 1px 0 rgba(0,0,0, 40%);
letter-spacing: 1px;
padding: 0 64px !important;
&::before {
position: absolute;
@@ -59,9 +37,11 @@ html {
z-index: -1;
display: inline-block;
height: 10px;
background: radial-gradient(ellipse at center,
background: radial-gradient(
ellipse at center,
rgba(0, 0, 0, 0.35) 0%,
rgba(0, 0, 0, 0) 80%);
rgba(0, 0, 0, 0) 80%
);
opacity: 0;
transition-duration: 0.3s;
transition-property: transform, opacity;
@@ -70,7 +50,6 @@ html {
&:hover {
transform: translateY(-5px);
&::before {
transform: translateY(5px);
opacity: 1;
@@ -88,17 +67,13 @@ html {
}
.__dumi-default-locale-select {
background: radial-gradient(100% 100% at 100% 0%,
#5ADAFF 0%,
#1890ff 100%) !important;
background: linear-gradient(45deg,#72a2de 30%,#5db8c7 90%) !important;
border-radius: 2px !important;
border: none !important;
a {
color: #fff !important;
letter-spacing: 0.6px;
}
&::before {
position: absolute;
top: 0;
@@ -108,26 +83,19 @@ html {
display: inline-block;
width: 0;
height: 0;
background: linear-gradient(225deg,
background: linear-gradient(
225deg,
white 45%,
#aaa 50%,
#ccc 56%,
white 80%);
white 80%
);
box-shadow: -1px 1px 1px rgba(0, 0, 0, 0.4);
opacity: 1;
transition-duration: 0.3s;
transition-property: width, height;
content: '';
[data-prefers-color=dark] & {
background: linear-gradient(225deg,
#141414 45%,
#aaa 50%,
#ccc 56%,
white 80%);
}
}
&:hover::before {
width: 14px;
height: 14px;
@@ -149,25 +117,3 @@ html {
border-radius: 2px !important;
border: 1px solid #0000000f;
}
// markdown
.markdown table {
width: auto !important;
a:hover {
text-decoration: none;
}
}
.markdown table td:first-child {
font-weight: normal !important;
}
code {
padding: 1px 5px !important;
border-radius: 4px;
color: #ff7875 !important;
background: rgba(0, 0, 0, 0.06) !important;
box-shadow: 0px 1px 0px 0px rgba(0, 0, 0, 0.1);
border: 1px solid rgba(0, 0, 0, 0.1);
}

3
less/main.less Normal file
View File

@@ -0,0 +1,3 @@
html {
scroll-behavior: smooth;
}

20
less/markdown.less Normal file
View File

@@ -0,0 +1,20 @@
.markdown table {
width: auto !important;
a:hover {
text-decoration: none;
}
}
.markdown table td:first-child {
font-weight: normal !important;
}
code {
padding: 1px 5px !important;
border-radius: 4px;
color: #ff7875 !important;
background: rgba(0, 0, 0, 0.06) !important;
box-shadow: 0px 1px 0px 0px rgba(0, 0, 0, 0.1);
border: 1px solid rgba(0,0,0,0.1);
}

View File

@@ -1,62 +1,49 @@
{
"private": true,
"description": "A GitHub Action easily helps you automatically manage issues.",
"main": "src/main.js",
"scripts": {
"start": "dumi dev",
"docs:build": "dumi build",
"docs-dev:build": "UMI_ENV=dev dumi build",
"docs:deploy": "gh-pages -d docs-dist",
"deploy": "npm run docs:build && npm run docs:deploy",
"format": "prettier --write **/*.ts **/*.js",
"format-check": "prettier --check **/*.ts **/*.js",
"test": "father test",
"package": "ncc build src/main.js -o dist",
"users": "node ./script/update-users.js",
"main": "node ./src/main.js",
"ver": "node ./script/update-version.js",
"pub": "npm run package"
},
"author": "xrkffgg",
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/actions-cool/issues-helper.git",
"branch": "main"
},
"license": "MIT",
"author": "xrkffgg",
"scripts": {
"dev": "APP_ROOT=web dumi dev",
"start": "APP_ROOT=web dumi dev",
"docs:build": "APP_ROOT=web dumi build",
"docs-dev:build": "APP_ROOT=web UMI_ENV=dev dumi build",
"docs:deploy": "gh-pages -d docs-dist",
"deploy": "npm run docs:build && npm run docs:deploy",
"format": "prettier --write **/*.ts **/*/*.ts",
"format-check": "prettier --check **/*.ts **/*/*.ts",
"lint": "eslint src/*.ts src/*/*.ts",
"lint-fix": "eslint src/*.ts src/*/*.ts --fix",
"lint-up": "npm run format && npm run lint-fix",
"lint-all": "npm run format-check && npm run lint",
"check-commit": "node ./scripts/check-commit.js",
"tag": "node ./scripts/tag.js",
"release": "node ./scripts/release",
"test": "father test",
"package": "ncc build src/main.ts -o dist",
"users": "node ./scripts/update-users.js",
"version": "node ./scripts/update-version.js",
"pub": "sh -e ./scripts/pub.sh",
"all": "npm run lint-all && npm run test && npm run package"
},
"keywords": [
"actions",
"issue",
"helper",
"github"
],
"dependencies": {
"@actions/core": "^1.10.0",
"@actions/core": "^1.2.6",
"@actions/github": "^4.0.0",
"@octokit/rest": "^18.0.12",
"actions-util": "^1.1.3",
"dayjs": "^1.9.7",
"father": "^2.30.7",
"lodash": "^4.17.20"
},
"devDependencies": {
"@trivago/prettier-plugin-sort-imports": "^2.0.4",
"@types/lodash": "^4.14.175",
"@typescript-eslint/parser": "^4.15.2",
"@umijs/fabric": "^2.5.6",
"@vercel/ncc": "^0.27.0",
"@vercel/ncc": "^0.25.1",
"common-tags": "^1.8.2",
"dumi": "^1.1.26",
"chalk": "^4.1.2",
"new-github-release-url": "^1.0.0",
"open": "^7.3.0",
"eslint": "^7.18.0",
"eslint-plugin-github": "^4.1.1",
"eslint-plugin-simple-import-sort": "^7.0.0",
"father": "^2.30.7",
"gh-pages": "^3.1.0",
"prettier": "^2.2.1",
"typescript": "^4.1.3",
"simple-git": "^2.46.0"
"gh-pages": "^3.1.0"
}
}

BIN
public/add-1.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

BIN
public/add-2.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB

BIN
public/duplicate.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB

BIN
public/month.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 49 KiB

View File

@@ -43,31 +43,29 @@ ${table}
// **************************************************************************
const point = '<table>';
const cnPoint = `## 图标`;
const enPoint = `## Badge`;
const ReadmeCN = './README.zh-CN.md';
const ReadmeEN = './README.md';
const cnPoint = `## README 图标`;
const enPoint = `## README Badge`;
// **************************************************************************
const cn = readFileSync(ReadmeCN, 'utf8');
const cn = readFileSync('./README.md', 'utf8');
const cnIn = cn.indexOf(point);
const cnAfterIn = cn.indexOf(cnPoint);
const cnBefore = cn.substring(0, cnIn);
const cnAfter = cn.substring(cnAfterIn, cn.length);
const newcn = cnBefore + table + cnAfter;
writeFileSync(ReadmeCN, newcn);
writeFileSync('./README.md', newcn);
console.log(`🎉 Done cn`);
// **************************************************************************
const en = readFileSync(ReadmeEN, 'utf8');
const en = readFileSync('./README.en-US.md', 'utf8');
const enIn = en.indexOf(point);
const enAfterIn = en.indexOf(enPoint);
const enBefore = en.substring(0, enIn);
const enAfter = en.substring(enAfterIn, en.length);
const newen = enBefore + table + enAfter;
writeFileSync(ReadmeEN, newen);
writeFileSync('./README.en-US.md', newen);
console.log(`🎉 Done en`);
// **************************************************************************

View File

@@ -1,7 +1,7 @@
const { readFileSync, writeFileSync } = require('fs');
const last = /@v2/g;
const now = `@v3`;
const last = /v2\.4\.2/g;
const now = `v2`;
let readme = readFileSync('./README.md', 'utf-8');
readme = readme.replace(last, now);
@@ -13,32 +13,32 @@ readmeen = readmeen.replace(last, now);
writeFileSync('./README.en-US.md', readmeen);
console.log('readmeen done!');
let index = readFileSync('./web/docs/index.md', 'utf-8');
let index = readFileSync('./docs/index.md', 'utf-8');
index = index.replace(last, now);
writeFileSync('./web/docs/index.md', index);
writeFileSync('./docs/index.md', index);
console.log('index done!');
let indexen = readFileSync('./web/docs/index.en-US.md', 'utf-8');
let indexen = readFileSync('./docs/index.en-US.md', 'utf-8');
indexen = indexen.replace(last, now);
writeFileSync('./web/docs/index.en-US.md', indexen);
writeFileSync('./docs/index.en-US.md', indexen);
console.log('indexen done!');
let base = readFileSync('./web/docs/base.md', 'utf-8');
let base = readFileSync('./docs/base.md', 'utf-8');
base = base.replace(last, now);
writeFileSync('./web/docs/base.md', base);
writeFileSync('./docs/base.md', base);
console.log('base done!');
let baseen = readFileSync('./web/docs/base.en-US.md', 'utf-8');
let baseen = readFileSync('./docs/base.en-US.md', 'utf-8');
baseen = baseen.replace(last, now);
writeFileSync('./web/docs/base.en-US.md', baseen);
writeFileSync('./docs/base.en-US.md', baseen);
console.log('baseen done!');
let adv = readFileSync('./web/docs/advanced.md', 'utf-8');
let adv = readFileSync('./docs/advanced.md', 'utf-8');
adv = adv.replace(last, now);
writeFileSync('./web/docs/advanced.md', adv);
writeFileSync('./docs/advanced.md', adv);
console.log('adv done!');
let adven = readFileSync('./web/docs/advanced.en-US.md', 'utf-8');
let adven = readFileSync('./docs/advanced.en-US.md', 'utf-8');
adven = adven.replace(last, now);
writeFileSync('./web/docs/advanced.en-US.md', adven);
writeFileSync('./docs/advanced.en-US.md', adven);
console.log('adven done!');

View File

@@ -1,23 +0,0 @@
const chalk = require('chalk');
const simpleGit = require('simple-git/promise');
const cwd = process.cwd();
const git = simpleGit(cwd);
async function checkCommit({ files }) {
if (files.length) {
console.log(chalk.yellow('🙄 You forgot something to commit.'));
files.forEach(({ path: filePath }) => {
console.log(' -', chalk.red(filePath));
});
console.log('');
process.exit(1);
}
}
async function run() {
const status = await git.status();
await checkCommit(status);
}
run();

View File

@@ -1,14 +0,0 @@
echo "[TEST] check format"
npm run format-check
echo "[TEST] test package"
npm run package
echo "[TEST] test commit"
npm run check-commit
echo "[Action] do tag"
npm run tag
echo "[Action] do release"
npm run release

View File

@@ -1,54 +0,0 @@
const chalk = require('chalk');
const open = require('open');
const newGithubReleaseUrl = require('new-github-release-url');
const { readFileSync } = require('fs');
const path = require('path');
let tag = '';
const CHANGELOG_NAME = 'CHANGELOG.md';
const user = 'actions-cool';
const repo = 'issues-helper';
function getChangelog(content) {
const lines = content.split('\n');
const changeLog = [];
const pin = /^## /;
let begin = false;
for (let i = 0; i < lines.length; i += 1) {
const line = lines[i];
if (begin && pin.test(line)) {
break;
}
if (begin && line) {
changeLog.push(line);
}
if (!begin) {
begin = pin.test(line);
if (begin) {
tag = line.substring(3, line.length).trim();
}
}
}
return changeLog.join('\n\n');
}
const changelogPath = path.join(__dirname, '..', CHANGELOG_NAME);
const changelog = readFileSync(changelogPath, 'utf-8');
const body = getChangelog(changelog);
async function run() {
const url = newGithubReleaseUrl({
user,
repo,
tag,
body: body,
});
await open(url);
console.log(chalk.yellow('🚀 Please check tag and changelog. Then click publish!'));
}
run();

View File

@@ -1,71 +0,0 @@
const chalk = require('chalk');
const simpleGit = require('simple-git/promise');
const { execSync } = require('child_process');
const { readFileSync } = require('fs');
const path = require('path');
const CHANGELOG_NAME = 'CHANGELOG.md';
const CHANGELOG_PATH = path.join(__dirname, '..', CHANGELOG_NAME);
const CHANGELOG = readFileSync(CHANGELOG_PATH, 'utf-8');
const cwd = process.cwd();
const git = simpleGit(cwd);
async function run() {
execSync(`git pull`);
const data = await git.tags();
const tags = data.all;
let tag = tags.reverse()[0];
console.log(chalk.green(`[Git Query] tag: ${tag}`));
const tagChangelog = getChangelogTag(CHANGELOG);
if (tagChangelog && tag != tagChangelog) {
console.log(chalk.yellow(`[Git Action] Push new ${tagChangelog} tag!`));
execSync(`git tag ${tagChangelog}`);
execSync(`git push origin ${tagChangelog}:${tagChangelog}`);
execSync(`git pull`);
tag = tagChangelog;
} else {
console.log(chalk.yellow('🙄 Please add new release changelog first.'));
console.log('');
process.exit(1);
}
const tagSimple = tag.startsWith('v') ? tag.substring(0, 2) : tag.substring(0, 1);
console.log(chalk.green(`[Git Query] tagSimple: ${tagSimple}`));
if (tags.includes(tagSimple)) {
console.log(chalk.yellow(`[Git Action] Delete ${tagSimple} tag`));
execSync(`git push origin :refs/tags/${tagSimple}`);
console.log(chalk.green(`[Git Action] Delete ${tagSimple} tag success`));
}
console.log(chalk.yellow(`[Git Action] Add new simple ${tagSimple} tag`));
execSync(`git push origin ${tag}:${tagSimple}`);
console.log(chalk.green('🎉 Done!'));
}
function getChangelogTag(content) {
const lines = content.split('\n');
const pin = /^## /;
let begin = false;
let tag = '';
for (let i = 0; i < lines.length; i += 1) {
const line = lines[i];
if (begin && pin.test(line)) {
break;
}
if (!begin) {
begin = pin.test(line);
if (begin) {
tag = line.substring(3, line.length);
}
}
}
return tag.trim();
}
run();

318
src/advanced.js Normal file
View File

@@ -0,0 +1,318 @@
const core = require('@actions/core');
const { Octokit } = require('@octokit/rest');
const {
doAddLabels,
doCreateComment,
doCloseIssue,
doLockIssue,
doCreateIssue,
} = require('./base.js');
const { doQueryIssues, getIssuesInMonth, getCreatedMonth } = require('./public.js');
const { dealStringToArr, matchKeyword, getPreMonth } = require('./util.js');
// **************************************************************************
var dayjs = require('dayjs');
var utc = require('dayjs/plugin/utc');
dayjs.extend(utc);
// **************************************************************************
const token = core.getInput('token');
const octokit = new Octokit({ auth: `token ${token}` });
let direction = core.getInput('direction');
direction = direction === 'desc' ? 'desc' : 'asc';
const commentAuth = core.getInput('comment-auth');
const bodyIncludes = core.getInput('body-includes');
const titleIncludes = core.getInput('title-includes');
const titleRemove = core.getInput('title-excludes');
const assigneeIncludes = core.getInput('assignee-includes');
let issueState = core.getInput('issue-state') || 'open';
if (issueState != 'all' && issueState != 'closed') {
issueState = 'open';
}
const inactiveLabel = core.getInput('inactive-label') || 'inactive';
// **************************************************************************
async function doCheckInactive(owner, repo, labels) {
const issues = await doQueryIssues(owner, repo, labels, issueState);
if (issues.length) {
for (let i = 0; i < issues.length; i++) {
let arr = [];
issues[i].labels.forEach(it => {
arr.push(it.name);
});
if (!arr.includes(inactiveLabel)) {
await doAddLabels(owner, repo, issues[i].number, inactiveLabel);
if (core.getInput('body')) {
await doCreateComment(owner, repo, issues[i].number, core.getInput('body'));
}
} else {
core.info(`Actions: [add-inactive] issue ${issues[i].number} has label!`);
}
}
} else {
core.info(`Actions: [query-issues] empty!`);
}
}
/**
* 检查 issue 是否满足条件,满足返回 true
* 当前 issue 的指定人是否有一个满足 assigneeIncludes 里的某个
* 关键字匹配,是否包含前一个某个+后一个某个 '官网,网站/挂了,无法访问'
*/
async function doCheckIssue(owner, repo, issueNumber) {
let checkResult = true;
const issue = await octokit.issues.get({
owner,
repo,
issue_number: issueNumber,
});
if (!!checkResult && assigneeIncludes) {
let assigneesCheck = dealStringToArr(assigneeIncludes);
let checkAssignee = false;
issue.data.assignees.forEach(it => {
if (checkResult && !checkAssignee && assigneesCheck.includes(it.login)) {
checkResult = true;
checkAssignee = true;
}
});
!checkAssignee ? (checkResult = false) : null;
}
if (!!checkResult && titleRemove) {
const removes = dealStringToArr(titleRemove);
let t = issue.data.title;
removes.forEach(re => {
t = t.replace(re, '');
});
if (t.trim().length == 0) {
checkResult = false;
}
}
if (!!checkResult && titleIncludes) {
const titleArr = titleIncludes.split('/');
const keyword1 = dealStringToArr(titleArr[0]);
const keyword2 = dealStringToArr(titleArr[1]);
checkResult = keyword2.length
? matchKeyword(issue.data.title, keyword1) && matchKeyword(issue.data.title, keyword2)
: matchKeyword(issue.data.title, keyword1);
}
if (!!checkResult && bodyIncludes) {
const bodyArr = bodyIncludes.split('/');
const keyword1 = dealStringToArr(bodyArr[0]);
const keyword2 = dealStringToArr(bodyArr[1]);
checkResult = keyword2.length
? matchKeyword(issue.data.body, keyword1) && matchKeyword(issue.data.body, keyword2)
: matchKeyword(issue.data.body, keyword1);
}
core.info(`Actions: [check-issue][${!!checkResult}] success!`);
core.setOutput('check-result', !!checkResult);
}
async function doCloseIssues(owner, repo, labels) {
const issues = await doQueryIssues(owner, repo, labels, 'open');
if (issues.length) {
for (let i = 0; i < issues.length; i++) {
await doCloseIssue(owner, repo, issues[i].number);
if (core.getInput('body')) {
await doCreateComment(owner, repo, issues[i].number, core.getInput('body'));
}
}
} else {
core.info(`Actions: [query-issues] empty!`);
}
}
async function doFindComments(owner, repo, issueNumber) {
const commentList = await listComments(owner, repo, issueNumber);
core.info(`Actions: [find-comments][${issueNumber}] success!`);
let comments = [];
commentList.forEach(item => {
const a = commentAuth ? item.user.login === commentAuth : true;
const b = bodyIncludes ? item.body.includes(bodyIncludes) : true;
if (a && b) {
comments.push({
id: item.id,
auth: item.user.login,
body: item.body,
created: item.created_at,
updated: item.updated_at,
});
if (direction === 'desc') {
comments.reverse();
}
}
});
core.setOutput('comments', comments);
core.info(`out-comments: ${JSON.stringify(comments)}`);
}
async function listComments(owner, repo, issueNumber, page = 1) {
let { data: comments } = await octokit.issues.listComments({
owner,
repo,
issue_number: issueNumber,
per_page: 100,
page,
});
if (comments.length >= 100) {
comments = comments.concat(await listComments(page + 1));
}
return comments;
}
async function doLockIssues(owner, repo, labels) {
const issues = await doQueryIssues(owner, repo, labels, issueState);
if (issues.length) {
for (let i = 0; i < issues.length; i++) {
await doLockIssue(owner, repo, issues[i].number);
if (core.getInput('body')) {
await doCreateComment(owner, repo, issues[i].number, core.getInput('body'));
}
}
} else {
core.info(`Actions: [query-issues] empty!`);
}
}
async function doMonthStatistics(owner, repo, labels, assignees) {
const countLables = core.getInput('count-lables');
const countComments = core.getInput('count-comments');
const thisMonth = dayjs.utc().month() + 1;
const year = thisMonth == 1 ? dayjs.utc().year() - 1 : dayjs.utc().year();
const month = getPreMonth(thisMonth);
const showMonth = month < 10 ? `0${month}` : month;
let issues = await getIssuesInMonth(owner, repo, thisMonth);
if (issues.length == 0) {
core.info(`Actions: [query-issues-${month}] empty!`);
return false;
}
issues = issues.filter(i => {
return getCreatedMonth(i.created_at) == month;
});
let total = issues.length;
let totalIssues = [...issues];
let openTotal = 0;
let openIssuesNumber = [];
let closeTotal = 0;
let closeIssuesNumber = [];
let labelsTotals = [];
const title = `[${owner}/${repo}] Month Statistics: ${year}-${showMonth}`;
for (let i = 0; i < issues.length; i++) {
if (issues[i].state == 'closed') {
closeTotal += 1;
closeIssuesNumber.push(issues[i].number);
} else if (issues[i].state == 'open') {
openTotal += 1;
openIssuesNumber.push(issues[i].number);
}
if (countLables && issues[i].labels) {
issues[i].labels.forEach(l => {
if (l.name in labelsTotals) {
labelsTotals[l.name] += 1;
} else {
labelsTotals[l.name] = 1;
}
});
}
}
let now = dayjs().utc().format('YYYY-MM-DD HH:mm:ss');
let body = `
- Created time: ${now}
- Time base: UTC +0
`;
let totalShow = `
### Count
| Total | Open | Closed |
| -- | -- | -- |
| ${total} | ${openTotal} | ${closeTotal} |
`;
body += totalShow;
if (countLables == 'true') {
let labelsArr = [];
for (var lab in labelsTotals) {
labelsArr.push({
labelName: lab,
number: labelsTotals[lab],
});
}
labelsArr.sort((a, b) => b.number - a.number);
let labelsTitle = `
### Labels statistics
<table>
<tr>
<th>Name</th>
<th>Number</th>
</tr>`;
let labelsBody = '';
labelsArr.forEach(it => {
labelsBody += `<tr><td>${it.labelName}</td><td>${it.number}</td></tr>`;
});
body =
body +
labelsTitle +
labelsBody +
`</table>
`;
}
if (countComments == 'true') {
totalIssues.sort((a, b) => b.comments - a.comments);
const maxComments = totalIssues.slice(0, 3);
let commentTitle = `
### Most comments
<table>
<tr>
<th>#</th>
<th>Issue</th>
<th>Title</th>
<th>Number</th>
<th>State</th>
</tr>
`;
let commentBody = '';
maxComments.forEach((it, ind) => {
commentBody += `<tr>
<td>${ind + 1}</td>
<td>${it.number}</td>
<td>${it.title}</td>
<td>${it.comments}</td>
<td>${it.state}</td></tr>`;
});
body = body + commentTitle + commentBody + '</table>';
}
await doCreateIssue(owner, repo, title, body, labels, assignees);
}
// **************************************************************************
module.exports = {
doCheckInactive,
doCheckIssue,
doCloseIssues,
doFindComments,
doLockIssues,
doMonthStatistics,
};

4
src/app.ts Normal file
View File

@@ -0,0 +1,4 @@
// For dumi style
import '../less/main.less';
import '../less/markdown.less';
import '../less/dumi.less';

533
src/base.js Normal file
View File

@@ -0,0 +1,533 @@
const core = require('@actions/core');
const github = require('@actions/github');
const { Octokit } = require('@octokit/rest');
// **************************************************************************
const ALLREACTIONS = ['+1', '-1', 'laugh', 'confused', 'heart', 'hooray', 'rocket', 'eyes'];
const { doQueryIssues } = require('./public.js');
const {
dealStringToArr,
dealRandomAssignees,
testDuplicate,
checkPermission,
} = require('./util.js');
// **************************************************************************
const token = core.getInput('token');
const octokit = new Octokit({ auth: `token ${token}` });
const context = github.context;
const contents = core.getInput('contents');
const randomTo = core.getInput('random-to');
// **************************************************************************
async function doAddAssignees(owner, repo, issueNumber, assignees) {
const arr = dealRandomAssignees(assignees, randomTo);
await octokit.issues.addAssignees({
owner,
repo,
issue_number: issueNumber,
assignees: arr,
});
core.info(`Actions: [add-assignees][${arr}] success!`);
}
async function doAddLabels(owner, repo, issueNumber, labels) {
await octokit.issues.addLabels({
owner,
repo,
issue_number: issueNumber,
labels: dealStringToArr(labels),
});
core.info(`Actions: [add-labels][${labels}] success!`);
}
async function doCloseIssue(owner, repo, issueNumber) {
await octokit.issues.update({
owner,
repo,
issue_number: issueNumber,
state: 'closed',
});
core.info(`Actions: [close-issue][${issueNumber}] success!`);
}
async function doCreateComment(owner, repo, issueNumber, body) {
const { data } = await octokit.issues.createComment({
owner,
repo,
issue_number: issueNumber,
body,
});
core.info(`Actions: [create-comment][${body}] success!`);
core.setOutput('comment-id', data.id);
if (contents) {
await doCreateCommentContent(owner, repo, data.id, dealStringToArr(contents));
}
}
async function doCreateCommentContent(owner, repo, commentId, contents) {
if (contents.length) {
contents.forEach(async item => {
if (testContent(item)) {
await octokit.reactions.createForIssueComment({
owner,
repo,
comment_id: commentId,
content: item,
});
core.info(`Actions: [create-reactions][${item}] success!`);
}
});
}
}
async function doCreateIssue(owner, repo, title, body, labels, assignees) {
let params = {
owner,
repo,
title,
body,
labels: dealStringToArr(labels),
assignees: dealRandomAssignees(assignees, randomTo),
};
const { data } = await octokit.issues.create(params);
core.info(`Actions: [create-issue][${title}] success!`);
core.setOutput('issue-number', data.number);
if (contents) {
await doCreateIssueContent(owner, repo, data.number, dealStringToArr(contents));
}
}
async function doCreateIssueContent(owner, repo, issueNumber, contents) {
if (contents.length) {
contents.forEach(async item => {
if (testContent(item)) {
await octokit.reactions.createForIssue({
owner,
repo,
issue_number: issueNumber,
content: item,
});
core.info(`Actions: [create-reactions][${item}] success!`);
}
});
}
}
async function doCreateLabel(owner, repo) {
const name = core.getInput('label-name');
const color = core.getInput('label-color') || 'ededed';
const description = core.getInput('label-desc') || '';
if (!name) {
core.setFailed(`This actions should input 'label-name'!`);
return false;
}
try {
await octokit.issues.createLabel({
owner,
repo,
name,
color,
description,
});
core.info(`Actions: [create-label][${name}] success!`);
} catch (err) {
console.log(err.message);
}
}
async function doDeleteComment(owner, repo, commentId) {
let id = commentId;
const outComments = core.getInput('out-comments');
if (outComments) {
const outCommentsArr = JSON.parse(outComments);
core.info(`Actions: [out-comments-length][${outCommentsArr.length}] success!`);
outCommentsArr.forEach(async item => {
await doDelet(item.id);
});
} else {
await doDelet(id);
}
async function doDelet(id) {
await octokit.issues.deleteComment({
owner,
repo,
comment_id: id,
});
core.info(`Actions: [delete-comment][${id}] success!`);
}
}
async function doLockIssue(owner, repo, issueNumber) {
const lockReason = core.getInput('lock-reason');
let params = {
owner,
repo,
issue_number: issueNumber,
};
const reasons = ['off-topic', 'too heated', 'resolved', 'spam'];
if (lockReason && reasons.includes(lockReason)) {
params.lock_reason = lockReason;
}
await octokit.issues.lock(params);
core.info(`Actions: [lock-issue][${issueNumber}] success!`);
}
async function doMarkDuplicate(owner, repo, labels) {
if (context.eventName != 'issue_comment') {
core.info(`This actions only support on 'issue_comment'!`);
return false;
}
if (context.payload.action == 'created' || context.payload.action == 'edited') {
const duplicateCommand = core.getInput('duplicate-command');
const duplicateLabels = core.getInput('duplicate-labels');
const removeLables = core.getInput('remove-labels');
const closeIssue = core.getInput('close-issue');
const requirePermission = core.getInput('require-permission') || 'write';
const commentId = context.payload.comment.id;
const commentBody = context.payload.comment.body;
const commentUser = context.payload.comment.user.login;
const issueNumber = context.payload.issue.number;
const ifCommandInput = !!duplicateCommand;
if (
!commentBody.includes('?') &&
((ifCommandInput &&
commentBody.startsWith(duplicateCommand) &&
commentBody.split(' ')[0] == duplicateCommand) ||
testDuplicate(commentBody))
) {
try {
const res = await octokit.repos.getCollaboratorPermissionLevel({
owner,
repo,
username: commentUser,
});
const { permission } = res.data;
if (!checkPermission(requirePermission, permission)) {
core.info(`The user ${commentUser} is not allow!`);
return false;
}
if (ifCommandInput) {
const nextBody = commentBody.replace(duplicateCommand, 'Duplicate of');
await doUpdateComment(owner, repo, commentId, nextBody, 'replace', true);
} else if (contents) {
await doCreateCommentContent(owner, repo, commentId, dealStringToArr(contents));
}
const issue = await octokit.issues.get({
owner,
repo,
issue_number: issueNumber,
});
let newLabels = [];
if (issue.data.labels.length > 0) {
newLabels = issue.data.labels
.map(({ name }) => name)
.filter(name => !dealStringToArr(removeLables).includes(name));
}
if (duplicateLabels) {
newLabels = [...newLabels, ...dealStringToArr(duplicateLabels)];
}
if (labels) {
newLabels = dealStringToArr(labels);
}
if (newLabels.length > 0) {
await doSetLabels(owner, repo, issueNumber, newLabels.toString());
core.info(`Actions: [mark-duplicate-labels][${newLabels}] success!`);
}
if (closeIssue == 'true') {
await doCloseIssue(owner, repo, issueNumber);
}
} catch (error) {
core.info(error.message);
}
} else {
core.info(
`This comment body should start whith 'duplicate-command' or 'Duplicate of' and not include '?'`,
);
}
} else {
core.info(`This actions only support on 'issue_comment' created or edited!`);
}
}
async function doOpenIssue(owner, repo, issueNumber) {
await octokit.issues.update({
owner,
repo,
issue_number: issueNumber,
state: 'open',
});
core.info(`Actions: [open-issue][${issueNumber}] success!`);
}
async function doRemoveAssignees(owner, repo, issueNumber, assignees) {
await octokit.issues.removeAssignees({
owner,
repo,
issue_number: issueNumber,
assignees: dealStringToArr(assignees),
});
core.info(`Actions: [remove-assignees][${assignees}] success!`);
}
async function doRemoveLabels(owner, repo, issueNumber, labels) {
const issue = await octokit.issues.get({
owner,
repo,
issue_number: issueNumber,
});
const baseLabels = issue.data.labels.map(({ name }) => name);
const removeLabels = baseLabels.filter(name => dealStringToArr(labels).includes(name));
core.info(`Actions: [filter-labels][${removeLabels.join(',')}] success!`);
for (const label of removeLabels) {
await octokit.issues.removeLabel({
owner,
repo,
issue_number: issueNumber,
name: label,
});
core.info(`Actions: [remove-label][${label}] success!`);
}
core.info(`Actions: [remove-labels][${labels}] success!`);
}
async function doSetLabels(owner, repo, issueNumber, labels) {
// 概率性出现问题https://github.com/octokit/rest.js/issues/1982规避 setLabels
if (labels) {
// await octokit.issues.setLabels({
// owner,
// repo,
// issue_number: issueNumber,
// labels: dealStringToArr(labels)
// });
const issue = await octokit.issues.get({
owner,
repo,
issue_number: issueNumber,
});
const baseLabels = issue.data.labels.map(({ name }) => name);
const removeLabels = baseLabels.filter(name => !dealStringToArr(labels).includes(name));
const addLabels = dealStringToArr(labels).filter(name => !baseLabels.includes(name));
if (removeLabels.length > 0) {
await doRemoveLabels(owner, repo, issueNumber, removeLabels.toString());
core.info(`Actions: [set-labels-remove][${removeLabels}] success!`);
}
if (addLabels.length > 0) {
await doAddLabels(owner, repo, issueNumber, addLabels.toString());
core.info(`Actions: [set-labels-add][${addLabels}] success!`);
}
core.info(`Actions: [set-labels][${labels}] success!`);
}
}
async function doUnlockIssue(owner, repo, issueNumber) {
await octokit.issues.unlock({
owner,
repo,
issue_number: issueNumber,
});
core.info(`Actions: [unlock-issue][${issueNumber}] success!`);
}
async function doUpdateComment(owner, repo, commentId, body, updateMode, ifUpdateBody) {
let id = commentId;
const outComments = core.getInput('out-comments');
if (outComments) {
const outCommentsArr = JSON.parse(outComments);
core.info(`Actions: [out-comments-length][${outCommentsArr.length}] success!`);
outCommentsArr.forEach(async item => {
await doComment(item.id);
});
} else {
await doComment(id);
}
async function doComment(id) {
const comment = await octokit.issues.getComment({
owner,
repo,
comment_id: id,
});
const comment_body = comment.data.body;
let params = {
owner,
repo,
comment_id: id,
};
if (core.getInput('body') || ifUpdateBody) {
if (updateMode === 'append') {
params.body = `${comment_body}\n${body}`;
} else {
params.body = body;
}
await octokit.issues.updateComment(params);
core.info(`Actions: [update-comment][${id}] success!`);
}
if (contents) {
await doCreateCommentContent(owner, repo, id, dealStringToArr(contents));
}
}
}
async function doUpdateIssue(
owner,
repo,
issueNumber,
state,
title,
body,
updateMode,
assignees,
labels,
) {
const issue = await octokit.issues.get({
owner,
repo,
issue_number: issueNumber,
});
const issue_body = issue.data.body;
const issue_title = issue.data.title;
let issue_labels = [];
if (issue.data.labels.length > 0) {
issue.data.labels.forEach(it => {
issue_labels.push(it.name);
});
}
let issue_assignees = [];
if (issue.data.assignees.length > 0) {
issue.data.assignees.forEach(it => {
issue_assignees.push(it.login);
});
}
let params = {
owner,
repo,
issue_number: issueNumber,
state,
};
params.title = core.getInput('title') ? title : issue_title;
let next_body;
if (core.getInput('body')) {
if (updateMode === 'append') {
next_body = `${issue_body}\n${body}`;
} else {
next_body = body;
}
} else {
next_body = issue_body;
}
params.body = next_body;
params.labels = labels ? dealStringToArr(labels) : issue_labels;
params.assignees = assignees ? dealStringToArr(assignees) : issue_assignees;
await octokit.issues.update(params);
core.info(`Actions: [update-issue][${issueNumber}] success!`);
if (contents) {
await doCreateIssueContent(owner, repo, issueNumber, contents);
}
}
async function doWelcome(owner, repo, assignees, labels, body) {
const context = github.context;
const isIssue = !!context.payload.issue;
const issueContents = core.getInput('issue-contents');
if (!isIssue) {
core.setFailed('The event that triggered this action must be a issue. Error!');
} else {
const auth = context.payload.sender.login;
core.info(`Actions: [welcome: auth=][${auth}]`);
const issueNumber = context.issue.number;
const issues = await doQueryIssues(owner, repo, false, 'all', auth);
if (issues.length == 0 || (issues.length == 1 && issues[0].number == issueNumber)) {
if (core.getInput('body')) {
await doCreateComment(owner, repo, issueNumber, body);
} else {
core.info(`Actions: [welcome] no body!`);
}
if (assignees) {
await doAddAssignees(owner, repo, issueNumber, assignees);
}
if (labels) {
await doAddLabels(owner, repo, issueNumber, labels);
}
if (issueContents) {
await doCreateIssueContent(owner, repo, issueNumber, dealStringToArr(issueContents));
}
} else {
core.info(`Actions: [welcome][${auth}] is not first time!`);
}
}
}
// **************************************************************************
function testContent(con) {
if (ALLREACTIONS.includes(con)) {
return true;
} else {
core.setFailed('This actions not supported!');
return false;
}
}
// **************************************************************************
module.exports = {
doAddAssignees,
doAddLabels,
doCloseIssue,
doCreateComment,
doCreateCommentContent,
doCreateIssue,
doCreateIssueContent,
doCreateLabel,
doDeleteComment,
doMarkDuplicate,
doLockIssue,
doOpenIssue,
doRemoveAssignees,
doRemoveLabels,
doSetLabels,
doUnlockIssue,
doUpdateComment,
doUpdateIssue,
doWelcome,
};

View File

@@ -1,7 +0,0 @@
# `@actions/core`
## Web
- https://github.com/actions/toolkit/tree/main/packages/core
![](https://github.com/actions-cool/resources/blob/main/image/annotations.png?raw=true)

View File

@@ -1,29 +0,0 @@
import * as core from '@actions/core';
export const baseInfo = (mess: string) => {
core.info(mess);
};
export const info = (mess: string) => {
core.info(`[📝 AC] ${mess}`);
};
export const error = (mess: string) => {
core.error(`[💥 AC] ${mess}`);
};
export const notice = (mess: string) => {
core.notice(`[🏷 AC] ${mess}`);
};
export const warning = (mess: string) => {
core.warning(`[🎃 AC] ${mess}`);
};
export const getInput = core.getInput;
export const setOutput = core.setOutput;
export const setFailed = (mess: string) => {
core.setFailed(`[🚨 AC] ${mess}`);
};

View File

@@ -1,421 +0,0 @@
import type { TPermissionType } from 'actions-util';
import { checkPermission, dealStringToArr } from 'actions-util';
import dayjs from 'dayjs';
import isSameOrBefore from 'dayjs/plugin/isSameOrBefore';
import utc from 'dayjs/plugin/utc';
import * as core from '../core';
import type { IIssueCoreEngine, IListIssuesParams, TCommentInfo, TIssueList } from '../issue';
import { EConst } from '../shared';
import type { TCloseReason, TEmoji, TIssueState, TOutList } from '../types';
import { checkDuplicate, matchKeyword, replaceStr2Arr } from '../util';
import {
doAddAssignees,
doAddLabels,
doCloseIssue,
doCreateComment,
doCreateCommentEmoji,
doLockIssue,
doRemoveLabels,
doSetLabels,
doUpdateComment,
} from './base';
let ICE: IIssueCoreEngine;
export function initAdvancedICE(_ICE: IIssueCoreEngine) {
ICE = _ICE;
}
export async function doQueryIssues(
state: TIssueState | 'all',
creator?: string,
ignoreLabels?: boolean,
): Promise<TIssueList> {
const params = {
state,
} as IListIssuesParams;
const issueCreator = core.getInput('issue-creator');
const issueAssignee = core.getInput('issue-assignee');
const issueMentioned = core.getInput('issue-mentioned');
if (issueCreator) params.creator = issueCreator;
if (issueAssignee) params.assignee = issueAssignee;
if (issueMentioned) params.mentioned = issueMentioned;
const labels = core.getInput('labels');
if (labels && !ignoreLabels) params.labels = labels;
if (creator) params.creator = creator;
const issuesList = await ICE.listIssues(params);
const issues: TIssueList = [];
const issueNumbers: number[] = [];
if (issuesList.length) {
const excludeLabels = core.getInput('exclude-labels') || '';
const bodyIncludes = core.getInput('body-includes');
const titleIncludes = core.getInput('title-includes');
const excludeLabelsArr = dealStringToArr(excludeLabels);
issuesList.forEach(issue => {
const bodyCheck = bodyIncludes ? issue.body.includes(bodyIncludes) : true;
const titleCheck = titleIncludes ? issue.title.includes(titleIncludes) : true;
/**
* Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request.
* For this reason, "Issues" endpoints may return both issues and pull requests in the response.
* You can identify pull requests by the pull_request key.
*/
if (bodyCheck && titleCheck && issue.pull_request === undefined) {
if (excludeLabelsArr.length) {
if (issue.labels.length) {
for (let i = 0; i < issue.labels.length; i += 1) {
if (excludeLabelsArr.includes(issue.labels[i].name)) return;
}
} else {
if (excludeLabelsArr.includes(EConst.ExcludeEmpty)) return;
}
}
const inactiveDay = core.getInput('inactive-day');
if (inactiveDay) {
dayjs.extend(utc);
dayjs.extend(isSameOrBefore);
const lastTime = dayjs.utc().subtract(+inactiveDay, 'day');
const updateTime = dayjs.utc(issue.updated_at);
if (updateTime.isSameOrBefore(lastTime)) {
issues.push(issue);
issueNumbers.push(issue.number);
}
} else {
issues.push(issue);
issueNumbers.push(issue.number);
}
}
});
}
core.info(`[doQueryIssues] issueNumbers is ---> ${JSON.stringify(issueNumbers)}`);
return issues;
}
export async function doCheckInactive(body: string, emoji?: string) {
let issueState = core.getInput('issue-state');
if (issueState !== 'all' && issueState !== 'closed') {
issueState = 'open';
}
const issues = await doQueryIssues(issueState as TIssueState | 'all');
if (issues.length) {
const inactiveLabel = core.getInput('inactive-label') || 'inactive';
for (const issue of issues) {
const { labels, number } = issue;
const labelNames = labels.map(({ name }) => name);
if (!labelNames.includes(inactiveLabel)) {
core.info(`[doCheckInactive] Doing ---> ${number}`);
await doAddLabels([inactiveLabel], number);
if (body) await doCreateComment(body, emoji, number);
} else {
core.info(`[doCheckInactive] The issue ${number} already has ${inactiveLabel} label!`);
}
}
} else {
core.info(`[doCheckInactive] Query issues empty!`);
}
}
/**
* 检查 issue 是否满足条件,满足返回 true
* 当前 issue 的指定人是否有一个满足 assigneeIncludes 里的某个
* 关键字匹配,是否包含前一个某个+后一个某个 '官网,网站/挂了,无法访问'
*/
export async function doCheckIssue() {
let checkResult = true;
const issue = await ICE.getIssue();
const assigneeIncludes = core.getInput('assignee-includes');
if (assigneeIncludes) {
const assigneesCheck = dealStringToArr(assigneeIncludes);
let checkAssignee = false;
issue.assignees.forEach(it => {
if (checkResult && !checkAssignee && assigneesCheck.includes(it.login)) {
checkResult = true;
checkAssignee = true;
}
});
if (!checkAssignee) checkResult = false;
}
const titleRemove = core.getInput('title-excludes');
if (!!checkResult && titleRemove) {
const removes = dealStringToArr(titleRemove);
let t = issue.title;
removes.forEach(re => {
t = t.replace(re, '');
});
if (t.trim().length == 0) {
checkResult = false;
}
}
const titleIncludes = core.getInput('title-includes');
if (!!checkResult && titleIncludes) {
const titleArr = titleIncludes.split('/');
const keyword1 = dealStringToArr(titleArr[0]);
const keyword2 = dealStringToArr(titleArr[1]);
checkResult = keyword2.length
? matchKeyword(issue.title, keyword1) && matchKeyword(issue.title, keyword2)
: matchKeyword(issue.title, keyword1);
}
const bodyIncludes = core.getInput('body-includes');
if (!!checkResult && bodyIncludes) {
const bodyArr = bodyIncludes.split('/');
const keyword1 = dealStringToArr(bodyArr[0]);
const keyword2 = dealStringToArr(bodyArr[1]);
checkResult =
keyword2 && keyword2.length
? matchKeyword(issue.body, keyword1) && matchKeyword(issue.body, keyword2)
: matchKeyword(issue.body, keyword1);
}
core.info(`[doCheckIssue] result is [${checkResult}]`);
core.setOutput('check-result', checkResult);
}
export async function doCloseIssues(body: string, closeReason: TCloseReason, emoji?: string) {
const issues = await doQueryIssues('open');
if (issues.length) {
for (const { number } of issues) {
core.info(`[doCloseIssues] Doing ---> ${number}`);
if (body) await doCreateComment(body, emoji, number);
await doCloseIssue(closeReason, number);
}
} else {
core.info(`[doCloseIssues] Query issues empty!`);
}
}
export async function doFindComments() {
const commentList = await ICE.listComments();
core.info(`[doFindComments] success!`);
const comments: TOutList = [];
if (commentList.length) {
const commentAuth = core.getInput('comment-auth');
const bodyIncludes = core.getInput('body-includes');
const direction = core.getInput('direction') === 'desc' ? 'desc' : 'asc';
for (const comment of commentList) {
const checkUser = commentAuth ? comment.user.login === commentAuth : true;
const checkBody = bodyIncludes ? comment.body.includes(bodyIncludes) : true;
if (checkUser && checkBody) {
comments.push({
id: comment.id,
auth: comment.user.login,
body: comment.body,
created: comment.created_at,
updated: comment.updated_at,
});
}
}
if (direction === 'desc') {
comments.reverse();
}
core.setOutput('comments', JSON.stringify(comments));
core.info(`[doFindComments] comments --> ${JSON.stringify(comments)}`);
} else {
core.info(`[doFindComments] Query comments empty!`);
}
}
export async function doFindIssues() {
let issueState = core.getInput('issue-state');
if (issueState !== 'all' && issueState !== 'closed') {
issueState = 'open';
}
const issueList = await doQueryIssues(issueState as TIssueState | 'all');
let issues: TOutList = [];
if (issueList.length) {
const direction = core.getInput('direction') === 'desc' ? 'desc' : 'asc';
issues = issueList.map(issue => {
return {
auth: issue.user.login,
number: issue.number,
title: issue.title,
body: issue.body,
state: issue.state,
created: issue.created_at,
updated: issue.updated_at,
};
});
if (direction === 'desc') {
issues.reverse();
}
core.info(`[doFindIssues] issues --> ${JSON.stringify(issues)}`);
} else {
core.info(`[doFindIssues] Query issues empty!`);
}
core.setOutput('issues', JSON.stringify(issues));
}
export async function doLockIssues(body: string, emoji?: string) {
let issueState = core.getInput('issue-state');
if (issueState !== 'all' && issueState !== 'closed') {
issueState = 'open';
}
const issues = await doQueryIssues(issueState as TIssueState | 'all');
if (issues.length) {
for (const { number } of issues) {
core.info(`[doLockIssues] Doing ---> ${number}`);
if (body) await doCreateComment(body, emoji, number);
await doLockIssue(number);
}
} else {
core.info(`[doLockIssues] Query issues empty!`);
}
}
export async function doMarkAssignees(comment: TCommentInfo) {
const assignCommand = core.getInput('assign-command') || '/assign';
if (comment.body.startsWith(assignCommand)) {
const { body, user } = comment;
const assigns = replaceStr2Arr(body, assignCommand, '@');
const requirePermission = core.getInput('require-permission') || 'write';
const permission = await ICE.getUserPermission(user.login);
if (!checkPermission(requirePermission as TPermissionType, permission)) {
core.info(`[doMarkAssignees] The user ${user.login} is not allow!`);
return;
}
await doAddAssignees(assigns);
core.info(`[doMarkAssignees] Done!`);
} else {
core.info(`[doMarkAssignees] The issues ignore!`);
}
}
export async function doMarkDuplicate(
comment: TCommentInfo,
closeReason: TCloseReason,
labels?: string[] | void,
emoji?: string,
) {
const duplicateCommand = core.getInput('duplicate-command');
const duplicateLabels = core.getInput('duplicate-labels');
const removeLables = core.getInput('remove-labels') || '';
const closeIssue = core.getInput('close-issue');
const requirePermission = core.getInput('require-permission') || 'write';
const commentId = comment.id;
const commentBody = comment.body;
const commentUser = comment.user.login;
const ifCommandInput = !!duplicateCommand;
if (
!commentBody.includes('?') &&
((ifCommandInput &&
commentBody.startsWith(duplicateCommand) &&
commentBody.split(' ')[0] == duplicateCommand) ||
checkDuplicate(commentBody))
) {
const permission = await ICE.getUserPermission(commentUser);
if (!checkPermission(requirePermission as TPermissionType, permission)) {
core.info(`[doMarkDuplicate] The user ${commentUser} is not allow!`);
return;
}
if (ifCommandInput) {
const nextBody = commentBody.replace(duplicateCommand, 'Duplicate of');
await doUpdateComment(commentId, nextBody, 'replace', emoji);
} else if (emoji) {
await doCreateCommentEmoji(commentId, emoji);
}
const issue = await ICE.getIssue();
let newLabels: string[] = [];
if (issue.labels.length > 0) {
newLabels = issue.labels
.map(({ name }) => name)
.filter(name => !dealStringToArr(removeLables).includes(name));
}
if (duplicateLabels) {
newLabels = [...newLabels, ...dealStringToArr(duplicateLabels)];
}
if (labels?.length) {
newLabels = [...labels];
}
if (newLabels.length > 0) {
await doSetLabels(newLabels);
}
if (closeIssue === 'true') {
await doCloseIssue(closeReason);
}
core.info(`[doMarkDuplicate] Done!`);
} else {
core.warning(
`This comment body should start with 'duplicate-command' or 'Duplicate of' and not include '?'`,
);
}
}
export async function doToggleLabels(labels: string[] = []) {
const issue = await ICE.getIssue();
const baseLabels: string[] = issue.labels.map(({ name }: any) => name);
const addLabels = [];
const removeLabels = [];
for (const label of labels) {
if (baseLabels.includes(label)) {
removeLabels.push(label);
} else {
addLabels.push(label);
}
}
if (removeLabels.length) {
await doRemoveLabels(removeLabels);
}
if (addLabels.length) {
await doAddLabels(addLabels);
}
core.info(`[doToggleLabels] Done!`);
}
export async function doWelcome(
auth: string,
issueNumber: number,
body: string,
labels?: string[] | void,
assignees?: string[] | void,
emoji?: string,
) {
core.info(`[doWelcome] [${auth}]`);
const issues = await doQueryIssues('all', auth, true);
if (issues.length == 0 || (issues.length == 1 && issues[0].number == issueNumber)) {
if (body) {
await doCreateComment(body, emoji);
}
if (assignees?.length) {
await doAddAssignees(assignees);
}
if (labels?.length) {
await doAddLabels(labels);
}
const issueEmoji = core.getInput('issue-emoji');
if (issueEmoji) {
await ICE.createIssueEmoji(dealStringToArr(issueEmoji) as TEmoji[]);
}
} else {
core.info(`[doWelcome] ${auth} is not first time!`);
}
}

View File

@@ -1,176 +0,0 @@
import { dealStringToArr } from 'actions-util';
import * as core from '../core';
import type { IIssueCoreEngine } from '../issue';
import { ELockReasons } from '../shared';
import type { TCloseReason, TEmoji, TIssueState, TLockReasons, TUpdateMode } from '../types';
let ICE: IIssueCoreEngine;
export function initBaseICE(_ICE: IIssueCoreEngine) {
ICE = _ICE;
}
export async function doAddAssignees(assignees: string[]) {
await ICE.addAssignees(assignees);
core.info(`[doAddAssignees] [${assignees}] success!`);
}
export async function doAddLabels(labels: string[], issueNumber?: number) {
if (issueNumber) ICE.setIssueNumber(issueNumber);
await ICE.addLabels(labels);
core.info(`[doAddLabels] [${labels}] success!`);
}
export async function doCloseIssue(reason: TCloseReason, issueNumber?: number) {
if (issueNumber) ICE.setIssueNumber(issueNumber);
await ICE.closeIssue(reason);
core.info(`[doCloseIssue] success!`);
}
export async function doCreateComment(body: string, emoji?: string, issueNumber?: number) {
if (body) {
if (issueNumber) ICE.setIssueNumber(issueNumber);
const commentId = await ICE.createComment(body);
core.info(`[doCreateComment] [${body}] success!`);
core.setOutput('comment-id', commentId);
if (emoji) {
await doCreateCommentEmoji(commentId, emoji);
}
} else {
core.warning(`[doCreateComment] body is empty!`);
}
}
export async function doCreateCommentEmoji(_commentId: number | void, emoji: string) {
const commentId = _commentId || core.getInput('comment-id');
if (emoji && commentId) {
await ICE.createCommentEmoji(+commentId, dealStringToArr(emoji) as TEmoji[]);
core.info(`[doCreateCommentEmoji] [${emoji}] success!`);
} else {
core.warning(`[doCreateCommentEmoji] emoji or commentId is empty!`);
}
}
export async function doCreateIssue(
title: string,
body: string,
labels?: string[],
assignees?: string[],
emoji?: string | void,
) {
if (title) {
const issueNumber = await ICE.createIssue(title, body, labels, assignees);
core.info(`[doCreateIssue] [${title}] success!`);
core.setOutput('issue-number', issueNumber);
if (emoji) {
ICE.setIssueNumber(issueNumber);
await ICE.createIssueEmoji(dealStringToArr(emoji) as TEmoji[]);
core.info(`[createIssueEmoji] [${emoji}] success!`);
}
} else {
core.warning(`[doCreateIssue] title is empty!`);
}
}
export async function doCreateLabel() {
const name = core.getInput('label-name');
const color = core.getInput('label-color') || 'ededed';
const description = core.getInput('label-desc') || '';
if (name) {
await ICE.createLabel(name, color, description);
core.info(`[doCreateLabel] [${name}] success!`);
} else {
core.warning(`[doCreateLabel] label-name is empty!`);
}
}
export async function doDeleteComment(_commentId: number | void) {
const commentId = _commentId || core.getInput('comment-id');
if (commentId) {
await ICE.deleteComment(+commentId);
core.info(`[doDeleteComment] [${commentId}] success!`);
} else {
core.warning(`[doDeleteComment] commentId is empty!`);
}
}
export async function doGetIssue() {
const { number, title, body, state, labels, assignees } = await ICE.getIssue();
core.setOutput('issue-number', number);
core.setOutput('issue-title', title || '');
core.setOutput('issue-body', body || '');
core.setOutput('issue-state', state);
const labelsString = labels.length ? labels.map(({ name }) => name).join(',') : '';
core.setOutput('issue-labels', labelsString);
const assigneesString = assignees.length ? assignees.map(({ login }) => login).join(',') : '';
core.setOutput('issue-body', assigneesString);
}
export async function doLockIssue(issueNumber?: number) {
if (issueNumber) ICE.setIssueNumber(issueNumber);
const lockReason = (core.getInput('lock-reason') || '') as TLockReasons;
if (lockReason && !ELockReasons[lockReason]) {
core.warning(`[doLockIssue] lock-reason is illegal!`);
return;
}
await ICE.lockIssue(lockReason as TLockReasons);
core.info(`[doLockIssue] success!`);
}
export async function doOpenIssue() {
await ICE.openIssue();
core.info(`[doOpenIssue] success!`);
}
export async function doRemoveAssignees(assignees: string[]) {
await ICE.removeAssignees(assignees);
core.info(`[doRemoveAssignees] [${assignees}] success!`);
}
export async function doRemoveLabels(labels: string[]) {
await ICE.removeLabels(labels);
core.info(`[doRemoveLabels] [${labels}] success!`);
}
export async function doSetLabels(labels: string[]) {
await ICE.setLabels(labels);
core.info(`[doSetLabels] [${labels}] success!`);
}
export async function doUnlockIssue() {
await ICE.unlockIssue();
core.info(`[doUnlockIssue] success!`);
}
export async function doUpdateComment(
_commentId: number | void,
body: string,
updateMode: TUpdateMode,
emoji: string | void,
) {
const commentId = _commentId || core.getInput('comment-id');
if (commentId) {
await ICE.updateComment(+commentId, body, updateMode);
core.info(`[doUpdateComment] [${commentId}] success!`);
if (emoji) {
await doCreateCommentEmoji(+commentId, emoji);
}
} else {
core.warning(`[doUpdateComment] commentId is empty!`);
}
}
export async function doUpdateIssue(
issueNumber: number,
state: TIssueState,
title: string | void,
body: string | void,
updateMode: TUpdateMode,
labels?: string[] | void,
assignees?: string[] | void,
) {
if (issueNumber) ICE.setIssueNumber(issueNumber);
await ICE.updateIssue(state, title, body, updateMode, labels, assignees);
core.info(`[doUpdateIssue] success!`);
}

View File

@@ -1,282 +0,0 @@
import { dealStringToArr } from 'actions-util';
import * as core from '../core';
import type { IIssueCoreEngine, TCommentInfo } from '../issue';
import { IssueCoreEngine } from '../issue';
import type { Context, TAction, TCloseReason, TIssueState, TUpdateMode } from '../types';
import { dealRandomAssignees } from '../util';
import {
doCheckInactive,
doCheckIssue,
doCloseIssues,
doFindComments,
doFindIssues,
doLockIssues,
doMarkAssignees,
doMarkDuplicate,
doToggleLabels,
doWelcome,
initAdvancedICE,
} from './advanced';
import {
doAddAssignees,
doAddLabels,
doCloseIssue,
doCreateComment,
doCreateIssue,
doCreateLabel,
doDeleteComment,
doGetIssue,
doLockIssue,
doOpenIssue,
doRemoveAssignees,
doRemoveLabels,
doSetLabels,
doUnlockIssue,
doUpdateComment,
doUpdateIssue,
initBaseICE,
} from './base';
import type { IIssueHelperEngine } from './types';
export class IssueHelperEngine implements IIssueHelperEngine {
private ICE!: IIssueCoreEngine;
private owner!: string;
private repo!: string;
private issueNumber!: number;
private emoji?: string;
private labels?: string[];
private assignees?: string[];
private title: string = '';
private body: string = '';
private state: TIssueState = 'open';
private updateMode: TUpdateMode = 'replace';
private closeReason: TCloseReason = 'not_planned';
public constructor(readonly ctx: Context) {
this.initInput(ctx);
this.initIssueCore();
initBaseICE(this.ICE);
initAdvancedICE(this.ICE);
}
private initInput(ctx: Context) {
// No display to outside
const repoInput = core.getInput('repo');
if (repoInput) {
this.owner = repoInput.split('/')[0];
this.repo = repoInput.split('/')[1];
} else {
this.owner = ctx.repo.owner;
this.repo = ctx.repo.repo;
}
let defaultCtxNumber: number | undefined;
if (ctx.eventName === 'issues' || ctx.eventName === 'issue_comment') {
defaultCtxNumber = ctx.payload.issue?.number;
}
const issueNumber = core.getInput('issue-number') || defaultCtxNumber;
if (issueNumber) {
this.issueNumber = +issueNumber;
} else {
core.warning(`'issue-number' is missing or this action not needed yet!`);
}
this.emoji = core.getInput('emoji') || '';
this.labels = dealStringToArr(core.getInput('labels') || '');
const assigneesInput = core.getInput('assignees') || '';
const randomTo = core.getInput('random-to');
this.assignees = dealRandomAssignees(assigneesInput, randomTo);
this.title = core.getInput('title') || '';
this.body = core.getInput('body') || '';
this.state = core.getInput('state') === 'closed' ? 'closed' : 'open';
this.updateMode = core.getInput('update-mode') === 'append' ? 'append' : 'replace';
this.closeReason = core.getInput('close-reason') === 'completed' ? 'completed' : 'not_planned';
}
private initIssueCore() {
const { owner, repo, issueNumber } = this;
const token = core.getInput('token');
this.ICE = new IssueCoreEngine({
owner,
repo,
issueNumber,
token,
});
core.info(`[Init] [${owner}/${repo} => ${issueNumber}]`);
}
public async doExeAction(action: TAction) {
const {
issueNumber,
emoji,
labels,
assignees,
title,
body,
updateMode,
state,
ctx,
closeReason,
} = this;
switch (action) {
// ---[ Base Begin ]--->>>
case 'add-assignees': {
if (assignees && assignees.length) {
await doAddAssignees(assignees);
} else {
core.warning(`[doAddAssignees] assignees is empty!`);
}
break;
}
case 'add-labels': {
if (labels && labels.length) {
await doAddLabels(labels);
} else {
core.warning(`[doAddLabels] labels is empty!`);
}
break;
}
case 'close-issue': {
await doCloseIssue(closeReason);
break;
}
case 'create-comment': {
await doCreateComment(body, emoji);
break;
}
case 'create-issue': {
await doCreateIssue(title, body, labels, assignees, emoji);
break;
}
case 'create-label': {
await doCreateLabel();
break;
}
case 'delete-comment': {
await doDeleteComment();
break;
}
case 'get-issue': {
await doGetIssue();
break;
}
case 'lock-issue': {
await doLockIssue();
break;
}
case 'open-issue': {
await doOpenIssue();
break;
}
case 'remove-assignees': {
if (assignees && assignees.length) {
await doRemoveAssignees(assignees);
} else {
core.warning(`[doRemoveAssignees] assignees is empty!`);
}
break;
}
case 'remove-labels': {
if (labels && labels.length) {
await doRemoveLabels(labels);
} else {
core.warning(`[doRemoveLabels] labels is empty!`);
}
break;
}
case 'set-labels': {
if (labels && labels.length) {
await doSetLabels(labels);
} else {
core.warning(`[doSetLabels] labels is empty!`);
}
break;
}
case 'unlock-issue': {
await doUnlockIssue();
break;
}
case 'update-comment': {
await doUpdateComment(0, body, updateMode, emoji);
break;
}
case 'update-issue': {
await doUpdateIssue(0, state, title, body, updateMode, labels, assignees);
break;
}
// ---[ Base End ]--->>>
// ^_^ ============= ^_^
// -[ Advanced Begin ]->
case 'check-inactive': {
await doCheckInactive(body, emoji);
break;
}
case 'check-issue': {
await doCheckIssue();
break;
}
case 'close-issues': {
await doCloseIssues(body, closeReason, emoji);
break;
}
case 'find-comments': {
await doFindComments();
break;
}
case 'find-issues': {
await doFindIssues();
break;
}
case 'lock-issues': {
await doLockIssues(body, emoji);
break;
}
case 'mark-assignees': {
if (this.checkEvent4Mark()) {
core.warning(`[mark-assignees] only support event '[issue_comment: created/edited]'!`);
return;
}
await doMarkAssignees(ctx.payload.comment as TCommentInfo);
break;
}
case 'mark-duplicate': {
if (this.checkEvent4Mark()) {
core.warning(`[mark-duplicate] only support event '[issue_comment: created/edited]'!`);
return;
}
await doMarkDuplicate(ctx.payload.comment as TCommentInfo, closeReason, labels, emoji);
break;
}
case 'toggle-labels': {
await doToggleLabels(labels);
break;
}
case 'welcome': {
if (ctx.eventName === 'issues' && ctx.payload.action === 'opened') {
await doWelcome(ctx.actor, issueNumber, body, labels, assignees, emoji);
} else {
core.warning('[welcome] only support issue opened!');
}
break;
}
// -[ Advanced End ]->
default: {
core.warning(`The ${action} is not allowed.`);
break;
}
}
}
private checkEvent4Mark() {
const { ctx } = this;
return (
ctx.eventName !== 'issue_comment' &&
(ctx.payload.action === 'created' || ctx.payload.action === 'edited')
);
}
}

View File

@@ -1,2 +0,0 @@
export * from './helper';
export * from './types';

View File

@@ -1,5 +0,0 @@
import type { TAction } from '../types';
export interface IIssueHelperEngine {
doExeAction: (action: TAction) => Promise<void>;
}

View File

@@ -1,2 +0,0 @@
export * from './issue';
export * from './types';

View File

@@ -1,337 +0,0 @@
import { Octokit } from '@octokit/rest';
import { EEmoji } from '../shared';
import type {
TCloseReason,
TEmoji,
TIssueState,
TLockReasons,
TUpdateMode,
TUserPermission,
} from '../types';
import type {
IIssueBaseInfo,
IIssueCoreEngine,
IListIssuesParams,
TCommentList,
TIssueInfo,
TIssueList,
} from './types';
export class IssueCoreEngine implements IIssueCoreEngine {
private owner!: string;
private repo!: string;
private issueNumber!: number;
private octokit!: Octokit;
public constructor(_info: IIssueBaseInfo) {
if (_info.owner && _info.repo) {
this.owner = _info.owner;
this.repo = _info.repo;
this.issueNumber = _info.issueNumber;
this.octokit = new Octokit({ auth: `token ${_info.token}` });
} else {
console.error(`Init failed, need owner、repo!`);
}
}
// Allow modify issue number in this way
public setIssueNumber(newIssueNumber: number) {
this.issueNumber = newIssueNumber;
}
public async addAssignees(assignees: string[]) {
const { owner, repo, octokit, issueNumber } = this;
await octokit.issues.addAssignees({
owner,
repo,
issue_number: issueNumber,
assignees,
});
}
public async addLabels(labels: string[]) {
const { owner, repo, octokit, issueNumber } = this;
await octokit.issues.addLabels({
owner,
repo,
issue_number: issueNumber,
labels,
});
}
public async closeIssue(reason: TCloseReason) {
const { owner, repo, octokit, issueNumber } = this;
await octokit.issues.update({
owner,
repo,
issue_number: issueNumber,
state: 'closed',
state_reason: reason,
});
}
public async createComment(body: string): Promise<number> {
const { owner, repo, octokit, issueNumber } = this;
const { data } = await octokit.issues.createComment({
owner,
repo,
issue_number: issueNumber,
body,
});
return data.id;
}
public async createCommentEmoji(commentId: number, emoji: TEmoji[]) {
const { owner, repo, octokit } = this;
for (const content of emoji) {
if (content && EEmoji[content]) {
await octokit.reactions.createForIssueComment({
owner,
repo,
comment_id: commentId,
content,
});
}
}
}
public async createIssue(
title: string,
body: string,
labels?: string[],
assignees?: string[],
): Promise<number> {
const { owner, repo, octokit } = this;
const { data } = await octokit.issues.create({
owner,
repo,
title,
body,
labels,
assignees,
});
return data.number;
}
public async createIssueEmoji(emoji: TEmoji[]) {
const { owner, repo, octokit, issueNumber } = this;
for (const content of emoji) {
if (content && EEmoji[content]) {
await octokit.reactions.createForIssue({
owner,
repo,
issue_number: issueNumber,
content,
});
}
}
}
public async createLabel(
labelName: string,
labelColor: string,
labelDescription: string | undefined,
) {
const { owner, repo, octokit } = this;
await octokit.issues.createLabel({
owner,
repo,
name: labelName,
color: labelColor,
description: labelDescription,
});
}
public async deleteComment(commentId: number) {
const { owner, repo, octokit } = this;
await octokit.issues.deleteComment({
owner,
repo,
comment_id: commentId,
});
}
public async getIssue() {
const { owner, repo, octokit, issueNumber } = this;
const issue = await octokit.issues.get({
owner,
repo,
issue_number: issueNumber,
});
return issue.data as unknown as TIssueInfo;
}
public async getUserPermission(username: string) {
const { owner, repo, octokit } = this;
const { data } = await octokit.repos.getCollaboratorPermissionLevel({
owner,
repo,
username,
});
return data.permission as TUserPermission;
}
public async listComments(page = 1) {
const { octokit, owner, repo, issueNumber } = this;
const { data } = await octokit.issues.listComments({
owner,
repo,
issue_number: issueNumber,
per_page: 100,
page,
});
let comments = [...data] as unknown as TCommentList;
if (comments.length >= 100) {
comments = comments.concat(await this.listComments(page + 1));
}
return comments;
}
public async listIssues(params: IListIssuesParams, page = 1) {
const { octokit, owner, repo } = this;
const { data } = await octokit.issues.listForRepo({
...params,
owner,
repo,
per_page: 100,
page,
});
let issues = [...data] as unknown as TIssueList;
if (issues.length >= 100) {
issues = issues.concat(await this.listIssues(params, page + 1));
}
return issues;
}
public async lockIssue(lockReason: TLockReasons) {
const { owner, repo, octokit, issueNumber } = this;
const params: any = {
owner,
repo,
issue_number: issueNumber,
};
if (lockReason) {
params.lock_reason = lockReason;
}
await octokit.issues.lock(params);
}
public async openIssue() {
const { owner, repo, octokit, issueNumber } = this;
await octokit.issues.update({
owner,
repo,
issue_number: issueNumber,
state: 'open',
});
}
public async removeAssignees(assignees: string[]) {
const { owner, repo, octokit, issueNumber } = this;
await octokit.issues.removeAssignees({
owner,
repo,
issue_number: issueNumber,
assignees,
});
}
public async removeLabels(labels: string[]) {
const { owner, repo, octokit, issueNumber } = this;
const issue = await this.getIssue();
const baseLabels: string[] = issue.labels.map(({ name }) => name);
const removeLabels = baseLabels.filter(name => labels.includes(name));
for (const label of removeLabels) {
await octokit.issues.removeLabel({
owner,
repo,
issue_number: issueNumber,
name: label,
});
}
}
public async setLabels(labels: string[]) {
// https://github.com/octokit/rest.js/issues/34
// - Probability to appear
// - avoid use setLabels
const issue = await this.getIssue();
const baseLabels: string[] = issue.labels.map(({ name }: any) => name);
const removeLabels = baseLabels.filter(name => !labels.includes(name));
const addLabels = labels.filter(name => !baseLabels.includes(name));
if (removeLabels.length) {
await this.removeLabels(removeLabels);
}
if (addLabels.length) {
await this.addLabels(addLabels);
}
}
public async unlockIssue() {
const { owner, repo, octokit, issueNumber } = this;
await octokit.issues.unlock({
owner,
repo,
issue_number: issueNumber,
});
}
public async updateComment(commentId: number, body: string, mode: TUpdateMode) {
const { owner, repo, octokit } = this;
const comment = await octokit.issues.getComment({
owner,
repo,
comment_id: commentId,
});
const baseBody = comment.data.body;
const newBody = body ? (mode === 'append' ? `${baseBody}\n${body}` : body) : baseBody;
await octokit.issues.updateComment({
owner,
repo,
comment_id: commentId,
body: newBody || '',
});
}
public async updateIssue(
state: TIssueState,
title: string | void,
body: string | void,
mode: TUpdateMode,
labels?: string[] | void,
assignees?: string[] | void,
) {
const { owner, repo, octokit, issueNumber } = this;
const issue = await this.getIssue();
const {
body: baseBody,
title: baseTitle,
labels: baseLabels,
assignees: baseAssigness,
state: baseState,
} = issue;
const baseLabelsName = baseLabels.map(({ name }: any) => name);
const baseAssignessName = baseAssigness?.map(({ login }: any) => login);
const newBody = body ? (mode === 'append' ? `${baseBody}\n${body}` : body) : baseBody;
await octokit.issues.update({
owner,
repo,
issue_number: issueNumber,
state: state || baseState,
title: title || baseTitle,
body: newBody,
labels: labels?.length ? labels : baseLabelsName,
assignees: assignees?.length ? assignees : baseAssignessName,
});
}
}

View File

@@ -1,117 +0,0 @@
import type {
TCloseReason,
TEmoji,
TIssueState,
TLockReasons,
TUpdateMode,
TUserPermission,
} from '../types';
export interface IIssueBaseInfo {
owner: string;
repo: string;
issueNumber: number;
token: string;
}
export interface IListIssuesParams {
state: TIssueState | 'all';
creator?: string;
assignee?: string;
mentioned?: string;
labels?: string;
}
export type TIssueInfo = {
number: number;
title: string;
body: string;
user: {
login: string;
};
assignees: {
login: string;
}[];
labels: {
name: string;
}[];
state: TIssueState;
created_at: string;
updated_at: string;
pull_request?: any;
};
export type TIssueList = TIssueInfo[];
export type TCommentInfo = {
id: number;
body: string;
user: {
login: string;
};
created_at: string;
updated_at: string;
};
export type TCommentList = TCommentInfo[];
export interface IIssueCoreEngine {
setIssueNumber: (newIssueNumber: number) => void;
addAssignees: (assignees: string[]) => Promise<void>;
addLabels: (labels: string[]) => Promise<void>;
closeIssue: (reason: TCloseReason) => Promise<void>;
/**
* @param body The comment body.
* @returns The create new comment id.
*/
createComment: (body: string) => Promise<number>;
createCommentEmoji: (commentId: number, emoji: TEmoji[]) => Promise<void>;
/**
* @param title
* @param body
* @param labels
* @param assignees
* @returns The create new issue number.
*/
createIssue: (
title: string,
body: string,
labels?: string[],
assignees?: string[],
) => Promise<number>;
createIssueEmoji: (emoji: TEmoji[]) => Promise<void>;
createLabel: (
labelName: string,
labelColor: string,
labelDescription: string | undefined,
) => Promise<void>;
deleteComment: (commentId: number) => Promise<void>;
getIssue: () => Promise<TIssueInfo>;
getUserPermission: (username: string) => Promise<TUserPermission>;
listComments: () => Promise<TCommentList>;
listIssues: (params: IListIssuesParams) => Promise<TIssueList>;
lockIssue: (lockReason: TLockReasons) => Promise<void>;
openIssue: () => Promise<void>;
removeAssignees: (assignees: string[]) => Promise<void>;
removeLabels: (labels: string[]) => Promise<void>;
setLabels: (labels: string[]) => Promise<void>;
unlockIssue: () => Promise<void>;
updateComment: (commentId: number, body: string, mode: TUpdateMode) => Promise<void>;
updateIssue: (
state: TIssueState,
title: string | void,
body: string | void,
mode: TUpdateMode,
labels?: string[] | void,
assignees?: string[] | void,
) => Promise<void>;
}

217
src/main.js Normal file
View File

@@ -0,0 +1,217 @@
const core = require('@actions/core');
const github = require('@actions/github');
const { THANKS } = require('actions-util/lib/thanks');
// **************************************************************************
const {
doAddAssignees,
doAddLabels,
doCloseIssue,
doCreateComment,
doCreateIssue,
doCreateLabel,
doDeleteComment,
doMarkDuplicate,
doLockIssue,
doOpenIssue,
doRemoveAssignees,
doRemoveLabels,
doSetLabels,
doUnlockIssue,
doUpdateComment,
doUpdateIssue,
doWelcome,
} = require('./base.js');
const {
doCheckInactive,
doCheckIssue,
doCloseIssues,
doFindComments,
doLockIssues,
doMonthStatistics,
} = require('./advanced.js');
// **************************************************************************
const ALLACTIONS = [
// base
'add-assignees',
'add-labels',
'close-issue',
'create-comment',
'create-issue',
'create-label',
'delete-comment',
'lock-issue',
'mark-duplicate',
'open-issue',
'remove-assignees',
'remove-labels',
'set-labels',
'unlock-issue',
'update-comment',
'update-issue',
'welcome',
// advanced
'check-inactive',
'check-issue',
'close-issues',
'find-comments',
'lock-issues',
'month-statistics',
];
// **************************************************************************
async function main() {
try {
const ctx = github.context;
// No display to outside
let owner, repo;
if (core.getInput('repo')) {
owner = core.getInput('repo').split('/')[0];
repo = core.getInput('repo').split('/')[1];
} else {
owner = ctx.repo.owner;
repo = ctx.repo.repo;
}
let defaultNo;
if (ctx.eventName === 'issues' || ctx.eventName === 'issue_comment') {
defaultNo = ctx.payload.issue.number;
}
const issueNumber = core.getInput('issue-number') || defaultNo;
const commentId = core.getInput('comment-id');
const defaultBody = `Currently at ${owner}/${repo}. And this is default comment.`;
const body = core.getInput('body') || defaultBody;
const defaultTitle = `Default Title`;
const title = core.getInput('title') || defaultTitle;
const assignees = core.getInput('assignees');
const labels = core.getInput('labels');
const state = core.getInput('state') || 'open';
let updateMode = core.getInput('update-mode');
if (updateMode !== 'append') {
updateMode = 'replace';
}
// actions
const actions = core.getInput('actions', { required: true });
const actionsArr = actions.split(',');
for (const action of actionsArr) {
await testActions(action.trim());
}
async function testActions(action) {
if (ALLACTIONS.includes(action)) {
await choseActions(action);
} else {
core.setFailed(`Actions: [${action}] is not supported!`);
}
}
async function choseActions(action) {
switch (action) {
// base
case 'add-assignees':
await doAddAssignees(owner, repo, issueNumber, assignees);
break;
case 'add-labels':
await doAddLabels(owner, repo, issueNumber, labels);
break;
case 'close-issue':
await doCloseIssue(owner, repo, issueNumber);
break;
case 'create-comment':
await doCreateComment(owner, repo, issueNumber, body);
break;
case 'create-issue':
await doCreateIssue(owner, repo, title, body, labels, assignees);
break;
case 'create-label':
await doCreateLabel(owner, repo);
break;
case 'delete-comment':
await doDeleteComment(owner, repo, commentId);
break;
case 'lock-issue':
await doLockIssue(owner, repo, issueNumber);
break;
case 'mark-duplicate':
await doMarkDuplicate(owner, repo, labels);
break;
case 'open-issue':
await doOpenIssue(owner, repo, issueNumber);
break;
case 'remove-assignees':
await doRemoveAssignees(owner, repo, issueNumber, assignees);
break;
case 'remove-labels':
await doRemoveLabels(owner, repo, issueNumber, labels);
break;
case 'set-labels':
await doSetLabels(owner, repo, issueNumber, labels);
break;
case 'unlock-issue':
await doUnlockIssue(owner, repo, issueNumber);
break;
case 'update-comment':
await doUpdateComment(owner, repo, commentId, body, updateMode);
break;
case 'update-issue':
await doUpdateIssue(
owner,
repo,
issueNumber,
state,
title,
body,
updateMode,
assignees,
labels,
);
break;
case 'welcome':
await doWelcome(owner, repo, assignees, labels, body);
break;
// advanced
case 'check-inactive':
await doCheckInactive(owner, repo, labels);
break;
case 'check-issue':
await doCheckIssue(owner, repo, issueNumber);
break;
case 'close-issues':
await doCloseIssues(owner, repo, labels);
break;
case 'find-comments':
await doFindComments(owner, repo, issueNumber);
break;
case 'lock-issues':
await doLockIssues(owner, repo, labels);
break;
case 'month-statistics':
await doMonthStatistics(owner, repo, labels, assignees);
break;
// default
default:
break;
}
}
core.info('\n' + THANKS);
} catch (error) {
core.setFailed(error.message);
}
}
// **************************************************************************
main();

View File

@@ -1,21 +0,0 @@
import * as github from '@actions/github';
import { dealStringToArr, THANKS } from 'actions-util';
import * as core from './core';
import { IssueHelperEngine } from './helper';
import type { TAction } from './types';
async function main() {
try {
const actions = core.getInput('actions', { required: true });
const IHE = new IssueHelperEngine(github.context);
for (const action of dealStringToArr(actions)) {
await IHE.doExeAction(action as TAction);
}
core.baseInfo(`\n${THANKS}`);
} catch (err: any) {
core.setFailed(err.message);
}
}
main();

139
src/public.js Normal file
View File

@@ -0,0 +1,139 @@
const core = require('@actions/core');
const { Octokit } = require('@octokit/rest');
const { getPreMonth, dealStringToArr } = require('./util.js');
// **************************************************************************
var dayjs = require('dayjs');
var utc = require('dayjs/plugin/utc');
dayjs.extend(utc);
var isSameOrBefore = require('dayjs/plugin/isSameOrBefore');
dayjs.extend(isSameOrBefore);
// **************************************************************************
const token = core.getInput('token');
const octokit = new Octokit({ auth: `token ${token}` });
const perPage = 100;
const issueCreator = core.getInput('issue-creator');
const issueAssignee = core.getInput('issue-assignee');
const issueMentioned = core.getInput('issue-mentioned');
const bodyIncludes = core.getInput('body-includes');
const titleIncludes = core.getInput('title-includes');
const excludeLabels = core.getInput('exclude-labels');
const inactiveDay = core.getInput('inactive-day');
// **************************************************************************
/**
* 查询 Issues 列表
* @param {*} owner
* @param {*} repo
* @param {*} labels
* @param {*} state
* @param {*} creator
* @returns
*/
async function doQueryIssues(owner, repo, labels, state, creator) {
let params = {
owner,
repo,
state,
};
issueCreator ? (params.creator = issueCreator) : null;
issueAssignee ? (params.assignee = issueAssignee) : null;
issueMentioned ? (params.mentioned = issueMentioned) : null;
if (labels) {
params.labels = labels;
}
if (creator) {
params.creator = creator;
}
const res = await getIssues(params);
let issues = [];
let issueNumbers = [];
if (res.length) {
const excludeLabelsArr = dealStringToArr(excludeLabels);
res.forEach(iss => {
const a = bodyIncludes ? iss.body.includes(bodyIncludes) : true;
const b = titleIncludes ? iss.title.includes(titleIncludes) : true;
/**
* Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request.
* For this reason, "Issues" endpoints may return both issues and pull requests in the response.
* You can identify pull requests by the pull_request key.
*/
if (a && b && iss.pull_request === undefined) {
if (excludeLabelsArr.length) {
for (let i = 0; i < iss.labels.length; i += 1) {
if (excludeLabelsArr.includes(iss.labels[i].name)) return;
}
}
if (inactiveDay) {
let lastTime = dayjs.utc().subtract(Number(inactiveDay), 'day');
let updateTime = dayjs.utc(iss.updated_at);
if (updateTime.isSameOrBefore(lastTime)) {
issues.push(iss);
issueNumbers.push(iss.number);
}
} else {
issues.push(iss);
issueNumbers.push(iss.number);
}
}
});
core.info(`Actions: [query-issues]: [${JSON.stringify(issueNumbers)}]!`);
}
return issues;
}
async function getIssues(params, page = 1) {
let { data: issues } = await octokit.issues.listForRepo({
...params,
per_page: perPage,
page,
});
if (issues.length >= perPage) {
issues = issues.concat(await getIssues(params, page + 1));
}
return issues;
}
async function getIssuesInMonth(owner, repo, thisMonth, page = 1) {
const month = getPreMonth(thisMonth);
let { data: issues } = await octokit.issues.listForRepo({
owner,
repo,
state: 'all',
per_page: perPage,
page,
});
issues = issues.filter(i => {
return i.pull_request === undefined;
});
if (issues.length && getCreatedMonth(issues[issues.length - 1].created_at) >= month) {
issues = issues.concat(await getIssuesInMonth(owner, repo, thisMonth, page + 1));
}
return issues;
}
// **************************************************************************
function getCreatedMonth(d) {
return dayjs(d).utc().month() + 1;
}
// **************************************************************************
module.exports = {
doQueryIssues,
getIssues,
getIssuesInMonth,
getCreatedMonth,
};

View File

@@ -1,21 +0,0 @@
export const EEmoji = {
'+1': '+1',
'-1': '-1',
laugh: 'laugh',
confused: 'confused',
heart: 'heart',
hooray: 'hooray',
rocket: 'rocket',
eyes: 'eyes',
};
export const ELockReasons = {
'off-topic': 'off-topic',
'too heated': 'too heated',
resolved: 'resolved',
spam: 'spam',
};
export const EConst = {
ExcludeEmpty: '$exclude-empty',
};

View File

@@ -1,61 +0,0 @@
import type { TPermissionType } from 'actions-util';
export { Context } from '@actions/github/lib/context';
export type TEmoji = '+1' | '-1' | 'laugh' | 'confused' | 'heart' | 'hooray' | 'rocket' | 'eyes';
export type TLockReasons = 'off-topic' | 'too heated' | 'resolved' | 'spam' | undefined;
export type TIssueState = 'open' | 'closed';
export type TUpdateMode = 'append' | 'replace';
export type TUserPermission = TPermissionType;
export type TCloseReason = 'completed' | 'not_planned';
export type TOutInfo = {
auth: string;
id?: number;
number?: number;
title?: string;
body?: string;
state?: TIssueState;
created: string;
updated: string;
};
export type TOutList = TOutInfo[];
export type TAction =
// [ Base Begin ]
| 'add-assignees'
| 'add-labels'
| 'close-issue'
| 'create-comment'
| 'create-issue'
| 'create-label'
| 'delete-comment'
| 'lock-issue'
| 'open-issue'
| 'remove-assignees'
| 'remove-labels'
| 'set-labels'
| 'unlock-issue'
| 'update-comment'
| 'update-issue'
// [ Base End ]
// ^_^ ========== ^_^
// [ Advanced Begin ]
| 'check-inactive'
| 'check-issue'
| 'close-issues'
| 'find-comments'
| 'find-issues'
| 'get-issue'
| 'lock-issues'
| 'mark-assignees'
| 'mark-duplicate'
| 'toggle-labels'
| 'welcome';
//// [ Advanced End ]

68
src/util.js Normal file
View File

@@ -0,0 +1,68 @@
const sampleSize = require('lodash/sampleSize');
function dealStringToArr(para) {
/**
* in 'x1,x2,x3'
* out ['x1','x2','x3']
*/
let arr = [];
if (para) {
const paraArr = para.split(',');
paraArr.forEach(it => {
if (it.trim()) {
arr.push(it.trim());
}
});
}
return arr;
}
function dealRandomAssignees(assignees, randomTo) {
let arr = dealStringToArr(assignees);
if (randomTo && Number(randomTo) > 0 && Number(randomTo) < arr.length) {
arr = sampleSize(arr, randomTo);
}
return arr;
}
function matchKeyword(content, keywords) {
return keywords.find(item => content.toLowerCase().includes(item));
}
function testDuplicate(body) {
if (!body || !body.startsWith('Duplicate of')) {
return false;
}
let arr = body.split(' ');
if (arr[0] == 'Duplicate' && arr[1] == 'of') {
return true;
} else {
return false;
}
}
function getPreMonth(m) {
return m == 1 ? 12 : m - 1;
}
function checkPermission(require, permission) {
/**
* 有权限返回 true
*/
const permissions = ['none', 'read', 'write', 'admin'];
const requireNo = permissions.indexOf(require);
const permissionNo = permissions.indexOf(permission);
return requireNo <= permissionNo;
}
// **********************************************************
module.exports = {
dealStringToArr,
dealRandomAssignees,
getPreMonth,
matchKeyword,
testDuplicate,
checkPermission,
};

View File

@@ -1,35 +0,0 @@
import { dealStringToArr } from 'actions-util';
import sampleSize from 'lodash/sampleSize';
export const dealRandomAssignees = (assignees: string, randomTo: string | void): string[] => {
let arr = dealStringToArr(assignees);
if (randomTo && Number(randomTo) > 0 && Number(randomTo) < arr.length) {
arr = sampleSize(arr, Number(randomTo));
}
return arr;
};
export const matchKeyword = (content: string = '', keywords: string[]): boolean => {
return !!keywords.find(item => content?.toLowerCase().includes(item));
};
export const checkDuplicate = (body: string | void): boolean => {
if (!body || !body.startsWith('Duplicate of')) {
return false;
}
const arr = body.split(' ');
return arr[0] == 'Duplicate' && arr[1] == 'of';
};
export const getPreMonth = (m: number): number => {
return m == 1 ? 12 : m - 1;
};
// replace some & split & cull empty
export const replaceStr2Arr = (str: string, replace: string, split: string): string[] => {
return str
.replace(replace, '')
.trim()
.split(split)
.reduce((result: string[], it) => (it ? [...result, it.trim()] : result), []);
};

View File

@@ -1,7 +1,5 @@
import { replaceStr2Arr } from '../src/util';
describe('Test', () => {
it('test doQueryIssues', () => {
describe('Test Public', () => {
it('test query', () => {
const issues = [
{
id: 0,
@@ -44,12 +42,4 @@ describe('Test', () => {
expect(r[2].id).toEqual(5);
expect(r.length).toEqual(3);
});
it('test replaceStr2Arr', () => {
const st = '/assign @1 @2 @3@a 3 @s @1_2 2';
const re = '/assign';
const sp = '@';
expect(replaceStr2Arr(st, re, sp)).toEqual(['1', '2', '3', 'a 3', 's', '1_2 2']);
});
});

View File

@@ -1,77 +0,0 @@
{
"compilerOptions": {
/* Basic Options */
// "incremental": true, /* Enable incremental compilation */
"target": "es6",
/* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
"module": "commonjs",
/* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
// "allowJs": true, /* Allow javascript files to be compiled. */
// "checkJs": true, /* Report errors in .js files. */
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
// "declaration": true, /* Generates corresponding '.d.ts' file. */
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
// "sourceMap": true, /* Generates corresponding '.map' file. */
// "outFile": "./", /* Concatenate and emit output to single file. */
"outDir": "./lib",
/* Redirect output structure to the directory. */
"rootDir": "./src",
/* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
// "composite": true, /* Enable project compilation */
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
// "removeComments": true, /* Do not emit comments to output. */
// "noEmit": true, /* Do not emit outputs. */
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
/* Strict Type-Checking Options */
"strict": true,
/* Enable all strict type-checking options. */
"noImplicitAny": true,
/* Raise error on expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* Enable strict null checks. */
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
/* Additional Checks */
// "noUnusedLocals": true, /* Report errors on unused locals. */
// "noUnusedParameters": true, /* Report errors on unused parameters. */
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
/* Module Resolution Options */
// "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
// "typeRoots": [], /* List of folders to include type definitions from. */
// "types": [], /* Type declaration files to be included in compilation. */
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
"esModuleInterop": true
/* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
/* Source Map Options */
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
/* Experimental Options */
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
},
"exclude": [
"node_modules",
"lib",
"dist",
"docs-dist",
"web",
"**/*.test.ts"
]
}

View File

@@ -1,2 +0,0 @@
// For dumi style
import './web.less';

View File

@@ -1,417 +0,0 @@
---
toc: menu
---
# 🌟 进 阶
进阶用法不建议 actions 多个一次同时使用。
## `check-inactive`
每月 1 号 UTC 0 时,对所有 30 天以上未活跃的 issues 增加 `inactive` 标签。
```yml
name: Check inactive
on:
schedule:
- cron: "0 0 1 * *"
jobs:
check-inactive:
runs-on: ubuntu-latest
steps:
- name: check-inactive
uses: actions-cool/issues-helper@v3
with:
actions: 'check-inactive'
token: ${{ secrets.GITHUB_TOKEN }}
inactive-day: 30
```
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/zh-CN/guide/ref#-token-说明) | string | ✖ |
| body | 操作 issue 时,可进行评论。不填时,不评论 | string | ✖ |
| emoji | 为该评论增加 [emoji](/zh-CN/guide/ref#-emoji-类型) | string | ✖ |
| labels | 标签筛选 | string | ✖ |
| issue-state | 状态筛选 | string | ✖ |
| issue-assignee | 指定人筛选 | string | ✖ |
| issue-creator | 创建人筛选 | string | ✖ |
| issue-mentioned | 提及人筛选 | string | ✖ |
| body-includes | 包含内容筛选 | string | ✖ |
| title-includes | 包含标题筛选 | string | ✖ |
| inactive-day | 非活跃天数筛选 | number | ✖ |
| inactive-label | 新增标签名称 | string | ✖ |
| exclude-labels | 排除标签筛选 | string | ✖ |
- `labels`:为多个时,会查询同时拥有多个。不填时,会查询所有
- `issue-state`:默认为 `all`。可选值 `open` `closed`,非这 2 项时,均为 `all`
- `issue-assignee`:不支持多人。不填或输入 * 时,查询所有。输入 `none` 会查询未添加指定人的 issues
- `inactive-day`:当输入时,会筛选 issue 更新时间早于当前时间减去非活跃天数。不填时,会查询所有
- `inactive-label`:默认为 `inactive`,可自定义其他。当项目未包含该 label 时,会自动新建
- `exclude-labels`:设置包含 `$exclude-empty` 时,可排除无 label issue
## `check-issue`
根据传入的参数和 `issue-number` 来检查该 issue 是否满足条件,返回一个布尔值。
下面的例子效果是:当 issue 新开时,校验当前 issue 指定人是否包含 `x1` 或者 `x2`,满足一个指定人即可校验通过,同时校验标题是否满足条件,[校验规则](/zh-CN/guide/ref#-includes-校验规则)。
```yml
name: Check Issue
on:
issues:
types: [edited]
jobs:
check-issue:
runs-on: ubuntu-latest
steps:
- name: check-issue
uses: actions-cool/issues-helper@v3
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 | ✔ |
| token | [token 说明](/zh-CN/guide/ref#-token-说明) | string | ✖ |
| issue-number | 指定的 issue当不传时会从触发事件中获取 | number | ✖ |
| assignee-includes | 是否包含指定人 | string | ✖ |
| title-includes | 标题包含校验 | string | ✖ |
| title-excludes | 检测标题移除默认 title 后是否为空 | string | ✖ |
| body-includes | 内容包含校验 | string | ✖ |
- `title-includes` `body-includes` 支持格式 `x1,x2` 或者 `x1,x2/y1,y2`。只支持两个层级
- 返回 `check-result`,由于 yml 原因,判断条件为 `if: steps.xxid.outputs.check-result == 'true'`
## `close-issues`
每 7 天 UTC 0 时,关闭已填加 `need info` label 且 7 天以上未活跃的 issues。
```yml
name: Check need info
on:
schedule:
- cron: "0 0 */7 * *"
jobs:
check-need-info:
runs-on: ubuntu-latest
steps:
- name: close-issues
uses: actions-cool/issues-helper@v3
with:
actions: 'close-issues'
token: ${{ secrets.GITHUB_TOKEN }}
labels: 'need info'
inactive-day: 7
```
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/zh-CN/guide/ref#-token-说明) | string | ✖ |
| body | 操作 issue 时,可进行评论。不填时,不评论 | string | ✖ |
| emoji | 为该评论增加 [emoji](/zh-CN/guide/ref#-emoji-类型) | string | ✖ |
| labels | 标签筛选 | string | ✖ |
| issue-assignee | 指定人筛选 | string | ✖ |
| issue-creator | 创建人筛选 | string | ✖ |
| issue-mentioned | 提及人筛选 | string | ✖ |
| body-includes | 包含内容筛选 | string | ✖ |
| title-includes | 包含标题筛选 | string | ✖ |
| inactive-day | 非活跃天数筛选 | number | ✖ |
| exclude-labels | 排除标签筛选 | string | ✖ |
| close-reason | 关闭原因。默认`not_planned`未计划,`completed`完成 | string | ✖ |
- `labels`:为多个时,会查询同时拥有多个。不填时,会查询所有
- `issue-assignee`:不支持多人。不填或输入 * 时,查询所有。输入 `none` 会查询未添加指定人的 issues
- `inactive-day`:当输入时,会筛选 issue 更新时间早于当前时间减去非活跃天数。不填时,会查询所有
- `exclude-labels`:设置包含 `$exclude-empty` 时,可排除无 label issue
## `find-comments`
查找当前仓库 1 号 issue 中,创建者是 k ,内容包含 `this` 的评论列表。
```yml
- name: Find comments
uses: actions-cool/issues-helper@v3
with:
actions: 'find-comments'
token: ${{ secrets.GITHUB_TOKEN }}
issue-number: 1
comment-auth: 'k'
body-includes: 'this'
```
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/zh-CN/guide/ref#-token-说明) | string | ✖ |
| issue-number | 指定的 issue当不传时会从触发事件中获取 | number | ✖ |
| comment-auth | 评论创建者,不填时会查询所有 | string | ✖ |
| body-includes | 评论内容包含过滤,不填时无校验 | string | ✖ |
| direction | 返回 `comments` 排序 | string | ✖ |
- 返回 `comments`,格式如下:
```js
[
{id: 1, auth: 'x', body: 'xxx', created: '', updated: ''},
{id: 2, auth: 'x', body: 'xxx', created: '', updated: ''},
]
```
- `direction` 默认为升序,只有设置 `desc` 时,会返回降序
- 返回数组中 `created` `updated`,由所处环境决定,会是 UTC +0
## `find-issues`
查找当前仓库,创建者是 k title 包含 `this` body 包含 `that`,打开状态的 issues 列表。
```yml
- name: Find issues
uses: actions-cool/issues-helper@v3
with:
actions: 'find-issues'
token: ${{ secrets.GITHUB_TOKEN }}
issue-creator: 'k'
issue-state: 'open'
title-includes: 'this'
body-includes: 'that'
```
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/zh-CN/guide/ref#-token-说明) | string | ✖ |
| issue-state | 状态筛选 | string | ✖ |
| issue-creator | 创建者筛选 | string | ✖ |
| title-includes | 标题包含过滤,不填时无校验 | string | ✖ |
| body-includes | 内容包含过滤,不填时无校验 | string | ✖ |
| exclude-labels | 排除标签筛选 | string | ✖ |
| inactive-day | 非活跃天数筛选 | number | ✖ |
| direction | 返回 `issues` 排序 | string | ✖ |
- 返回 `issues`,格式如下:
```js
[
{number: 1, auth: 'x', body: 'xxx', body: 'xxx', state: 'open', created: '', updated: ''},
{number: 2, auth: 'x', body: 'xxx', body: 'xxx', state: 'closed', created: '', updated: ''},
]
```
- `direction` 默认为升序,只有设置 `desc` 时,会返回降序
- 返回数组中 `created` `updated`,由所处环境决定,会是 UTC +0
- `exclude-labels`:设置包含 `$exclude-empty` 时,可排除无 label issue
## `lock-issues`
每 3 个月 1 号 UTC 0 时,锁定已填加 `inactive` label 且 128 天以上未活跃的所有 issues。
```yml
name: Lock inactive issues
on:
schedule:
- cron: "0 0 1 */3 *"
jobs:
lock-issues:
runs-on: ubuntu-latest
steps:
- name: lock-issues
uses: actions-cool/issues-helper@v3
with:
actions: 'lock-issues'
token: ${{ secrets.GITHUB_TOKEN }}
labels: 'inactive'
inactive-day: 128
```
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/zh-CN/guide/ref#-token-说明) | string | ✖ |
| body | 操作 issue 时,可进行评论。不填时,不评论 | string | ✖ |
| emoji | 为该评论增加 [emoji](/zh-CN/guide/ref#-emoji-类型) | string | ✖ |
| labels | 标签筛选 | string | ✖ |
| issue-state | 状态筛选 | string | ✖ |
| issue-assignee | 指定人筛选 | string | ✖ |
| issue-creator | 创建人筛选 | string | ✖ |
| issue-mentioned | 提及人筛选 | string | ✖ |
| body-includes | 包含内容筛选 | string | ✖ |
| title-includes | 包含标题筛选 | string | ✖ |
| inactive-day | 非活跃天数筛选 | number | ✖ |
| lock-reason | 锁定 issue 的原因 | string | ✖ |
| exclude-labels | 排除标签筛选 | string | ✖ |
- `labels`:为多个时,会查询同时拥有多个。不填时,会查询所有
- `issue-state`:默认为 `all`。可选值 `open` `closed`,非这 2 项时,均为 `all`
- `issue-assignee`:不支持多人。不填或输入 * 时,查询所有。输入 `none` 会查询未添加指定人的 issues
- `inactive-day`:当输入时,会筛选 issue 更新时间早于当前时间减去非活跃天数。不填时,会查询所有
- `exclude-labels`:设置包含 `$exclude-empty` 时,可排除无 label issue
## `mark-assignees`
快捷加指定人,仅作用于 issue 新增编辑评论。
```yml
name: Issue Mark Assignees
on:
issue_comment:
types: [created, edited]
jobs:
mark-assignees:
runs-on: ubuntu-latest
steps:
- name: mark-assignees
uses: actions-cool/issues-helper@v3
with:
actions: 'mark-assignees'
token: ${{ secrets.GITHUB_TOKEN }}
```
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/zh-CN/guide/ref#-token-说明) | string | ✖ |
| assign-command | 可设置简洁命令,如:`/a` | string | ✖ |
| require-permission | 要求权限,默认为 `write` | string | ✖ |
- `assign-command`:可设置简洁命令。默认:`/assign`
- `require-permission`:可选值有 `admin``write``read``none`
- 团队成员若设置 `read` 权限,则为 `read`
- 外部 Collaborator 若设置 `read` 权限,则为 `read`
- 普通用户为 `read` 权限
- 当设置 `write` 后,`admin``write` 满足条件
## `mark-duplicate`
快捷标记重复问题,仅作用于 issue 新增编辑评论。
```yml
name: Issue Mark Duplicate
on:
issue_comment:
types: [created, edited]
jobs:
mark-duplicate:
runs-on: ubuntu-latest
steps:
- name: mark-duplicate
uses: actions-cool/issues-helper@v3
with:
actions: 'mark-duplicate'
token: ${{ secrets.GITHUB_TOKEN }}
```
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/zh-CN/guide/ref#-token-说明) | string | ✖ |
| duplicate-command | 可设置简洁命令,如:`/d` | string | ✖ |
| duplicate-labels | 为该 issue 额外增加 labels | string | ✖ |
| remove-labels | 设置可移除的 labels | string | ✖ |
| labels | 替换该 issue 的 labels | string | ✖ |
| emoji | 为该评论的增加 [emoji](/zh-CN/guide/ref#-emoji-类型) | string | ✖ |
| close-issue | 是否同时关闭该 issue | string | ✖ |
| require-permission | 要求权限,默认为 `write` | string | ✖ |
| close-reason | 关闭原因。默认`not_planned`未计划,`completed`完成 | string | ✖ |
- `duplicate-command`:当设置简洁命令时,同时仍支持原有 `Duplicate of`。屏蔽内容包含 `?`
- `labels`:优先级最高
- `close-issue``true``'true'` 均可生效
- `require-permission`:可选值有 `admin``write``read``none`
- 团队成员若设置 `read` 权限,则为 `read`
- 外部 Collaborator 若设置 `read` 权限,则为 `read`
- 普通用户为 `read` 权限
- 当设置 `write` 后,`admin``write` 满足条件
<Alert>
注意:使用简洁命令创建的 Duplicate 不显示下图红框内容。但其实这个没有任何影响的。
</Alert>
![](https://gw.alipayobjects.com/mdn/rms_f97235/afts/img/A*PN2tS7PjDQ4AAAAAAAAAAAAAARQnAQ)
## `toggle-labels`
当一个 issue 被重新打开,判断设置的 labels 如果已经存在则进行删除,否则进行添加。
```yml
name: Toggle Labels
on:
issues:
types: [reopened]
jobs:
toggle-labels:
runs-on: ubuntu-latest
steps:
- name: Toggle labels
uses: actions-cool/issues-helper@v3
with:
actions: 'toggle-labels'
token: ${{ secrets.GITHUB_TOKEN }}
issue-number: ${{ github.event.issue.number }}
labels: 'unread,outdated'
```
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/zh-CN/guide/ref#-token-说明) | string | ✖ |
| issue-number | 指定的 issue当不传时会从触发事件中获取 | number | ✖ |
| labels | 切换 labels。如果 label 已存在则删除,不存在则添加 | string | ✖ |
## `welcome`
当一个 issue 新建时,对首次新建 issue 的用户进行欢迎。若用户非首次新建,则无操作。
```yml
name: Issue Welcome
on:
issues:
types: [opened]
jobs:
issue-welcome:
runs-on: ubuntu-latest
steps:
- name: welcome
uses: actions-cool/issues-helper@v3
with:
actions: 'welcome'
token: ${{ secrets.GITHUB_TOKEN }}
body: hi @${{ github.event.issue.user.login }}, welcome!
labels: 'welcome1, welcome2'
assignees: 'xx1'
issue-emoji: '+1, -1, eyes'
```
| 参数 | 描述 | 类型 | 必填 |
| -- | -- | -- | -- |
| actions | 操作类型 | string | ✔ |
| token | [token 说明](/zh-CN/guide/ref#-token-说明) | string | ✔ |
| body | 评论欢迎的内容,不填则不评论 | string | ✖ |
| labels | 为该 issue 增加 labels | string | ✖ |
| assignees | 为该 issue 增加 assignees | string | ✖ |
| issue-emoji | 为该 issue 增加 [emoji](/zh-CN/guide/ref#-emoji-类型) | string | ✖ |
- 若这 4 个可选项都不填,则无操作

View File

@@ -1,10 +0,0 @@
---
toc: menu
---
# ✨ Changelog
- v2 [upgrade reference](/guide/faq)
- v3 [changelog](/guide/faq#v3-changelog)
<embed src="../../CHANGELOG.md"></embed>

View File

@@ -1,10 +0,0 @@
---
toc: menu
---
# ✨ 更新日志
- v2 [升级参考](/zh-CN/guide/faq)
- v3 [变更](/zh-CN/guide/faq/#v3-变更)
<embed src="../../CHANGELOG.md"></embed>

View File

@@ -1,88 +0,0 @@
---
toc: menu
---
## Is there a charge for this feature?
GitHub Actions is provided free of charge by GitHub. Among them, the `Private` project has a monthly limit of 2000 times, [see details](https://github.com/settings/billing). The `Public` project is unlimited.
### Is there a rate limit?
Yes. The bottom layer of Action uses GitHub REST API. The general situation is 5000 times per hour. It is basically sufficient in principle, and it is also required to avoid invalid requests when defining Action. [Detailed view](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting).
## Are there any ready-made templates for reference?
Yes.
1. You can use this [GitHub Actions workflow template](https://github.com/actions-cool/.github) repository template
2. Personal exercises and tests [Actions](https://github.com/actions-cool/test-issues-helper) repository
3. You can also refer to the warehouse of [online users](#-who-is-using)
## I want to pause Actions, is there an easy way?
Yes, you can directly modify `actions`. For example: `actions:'create-comment'` is changed to `actions:'#create-comment'`. It is also convenient for recovery.
## So many versions, how to choose?
You can view the detailed [changelog](/changelog). The latest releases version is recommended.
- 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 or undergoes refactoring, release the advanced v2.x version
- After the v2 version, the version will be released strictly according to the three-level semantics, such as v2.0.0, v2.1.0
- 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
- The latest v1.x release code will be merged into the 1.x branch
- After the v2 version, the v2 tag is supported, and the latest 2.x code will be synchronized
- It also supports the direct use of branch versions. Such as:
```yml
- name: Issues Helper
uses: actions-cool/issues-helper@main
# or
- name: Issues Helper
uses: actions-cool/issues-helper@1.x
# or
- name: Issues Helper
uses: actions-cool/issues-helper@v2
```
## What should I pay attention to when upgrading from v1.x to v2?
There is only one difference between v1.12 and v2.0.0. That is, `require-permission` in `mark-duplicate` has added the default value `write`.
## v3 changelog
🚀 The refactoring of the v3 version is completed. The main changes are:
1. JS to TS
2. Encapsulate the core functions of the issue into classes for helpers to use
3. Unified prompt information
4. Added automatic release script
Reference for functional changes:
- 🚀 New Feature
- `mark-assignees`: Comment quick settings assignees
- `find-issues`: Conditional query current warehouse issues
- 🐞 Bug Fix
- Fixed `find-comments` return result direction not working
- Fix `lock-issues` lock and comment order issue
- 🛠 Refactor
- `contents` renamed to easy-to-understand `emoji`
- `issue-emojis` renamed to `issue-emoji`
- deleteComment updateComment no longer supports `out-comments`, keeping pure functionality
- Remove title body default
- `month-statistics` removed
## What should I do if there is no function I want here?
You can submit it in [What do you want?](https://github.com/actions-cool/issues-helper/discussions/18).

View File

@@ -1,88 +0,0 @@
---
toc: menu
---
## 该功能是否收费?
GitHub Actions 是由 GitHub 免费提供的。其中 `Private` 项目每月有 2000 次的限制,[具体查看](https://github.com/settings/billing)。`Public` 项目无限制。
### 有没有速率的限制?
有的。Action 底层使用的是 GitHub REST API。一般情况是每小时 5000 次。原则上基本是够用的,同时也要求在 Action 定义时,尽量避免无效的请求。[具体查看](https://docs.github.com/en/rest/overview/resources-in-the-rest-api#rate-limiting)。
## 有没有现成的模板可以参考?
有的。
1. 你可以使用这个 [GitHub Actions workflow template](https://github.com/actions-cool/.github) 仓库的模板
2. 个人练习和测试 [Actions](https://github.com/actions-cool/test-issues-helper) 的仓库
3. 也可以来 [线上使用者](/zh-CN/#-谁在使用?) 的仓库参照
## 我想暂停 Actions有没有简单的办法
有的,你可以将直接修改 `actions`。例如:`actions: 'create-comment'` 修改为 `actions: '#create-comment'`。同时也方便恢复。
## 这么多版本,如何选择?
你可以查看详细的 [更新日志](/zh-CN/changelog)。推荐采用最新 releases 版本。
- 版本规则
- 采用两级语义化版本如v1、v1.1、v2、v2.1
- v1 表示初始版本
- 对 v1 版本的修复和新增会发布到 v1.1 版本
- 当发布的 v1.x 运行一定时间稳定或进行重构时,发布进阶 v2.x 版本
- v2 版本后会严格按照三级语义来发布版本,如 v2.0.0、v2.1.0
- 版本选择
- 建议采用最新 releases 版本。可在 [releases](https://github.com/actions-cool/issues-helper/releases) 看到
- 同时也可参照下面的更新日志来选择版本
- 最新的 v1.x release 代码会合并到 1.x 分支中
- v2 版本后支持使用 v2 tag将同步最新 2.x 代码
- 支持直接使用分支版本。如:
```yml
- name: Issues Helper
uses: actions-cool/issues-helper@main
# or
- name: Issues Helper
uses: actions-cool/issues-helper@1.x
# or
- name: Issues Helper
uses: actions-cool/issues-helper@v3
```
## 从 v1.x 升级到 v2有什么注意的地方吗
v1.12 和 v2.0.0 版本的差别只有一处。即 `mark-duplicate` 中的 `require-permission` 增加了默认值 `write`
## v3 变更
🚀 v3 版本重构完成,主要变更内容:
1. JS to TS
2. 将 issue 核心功能封装成为类供 helper 使用
3. 提示信息统一
4. 增加自动发布脚本
功能变更参考:
- 🚀 New Feature
- `mark-assignees`: 评论快捷设置 assignees
- `find-issues`: 条件查询当前仓库 issues
- 🐞 Bug Fix
- 修复 `find-comments` 返回结果 direction 未起作用
- 修复 `lock-issues` lock 与 comment 的顺序问题
- 🛠 Refactor
- contents 更名为容易理解的 emoji
- `issue-emojis` 更名为 `issue-emoji`
- deleteComment updateComment 不再支持 `out-comments`,保持纯粹功能
- 移除 title body 默认值
- `month-statistics` 移除
## 如果这里没有我想要的功能,该怎么办?
你可以在 issues 中提出。

7482
yarn.lock

File diff suppressed because it is too large Load Diff