actions-cool/issues-helper
1
0
Fork 0
mirror of https://gitea.com/Lydanne/issues-helper.git synced 2025-10-15 00:04:21 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: up website & sh

Browse Source
This commit is contained in:
元凛
2022-02-09 17:24:35 +08:00
parent f6cad1ea63
commit 1a0a9f0bf6
41 changed files with 1340 additions and 2278 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
web/docs/guide/faq.en-US.md
View File

@@ -26,10 +26,62 @@ Yes, you can directly modify `actions`. For example: `actions:'create-comment'`
You can view the detailed [changelog](/en-US/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`
- deleteComment updateComment no longer supports `out-comments`, keeping pure functionality
- Remove title body default
- `month-statistics` is removed, can use [issues-month-statistics](https://github.com/actions-cool/issues-month-statistics)
## 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).

54
web/docs/guide/faq.md
View File

@@ -26,10 +26,62 @@ GitHub Actions 是由 GitHub 免费提供的。其中 `Private` 项目每月有
你可以查看详细的 [更新日志](/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
- deleteComment updateComment 不再支持 `out-comments`，保持纯粹功能
- 移除 title body 默认值
- `month-statistics` 移除，可使用 [issues-month-statistics](https://github.com/actions-cool/issues-month-statistics)
## 如果这里没有我想要的功能，该怎么办？
你可以在 [What do you want?](https://github.com/actions-cool/issues-helper/discussions/18) 中提出。
你可以在 issues 中提出。

1
web/docs/guide/note.en-US.md
View File

@@ -44,6 +44,7 @@ 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

1
web/docs/guide/note.md
View File

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

2
web/docs/guide/ref.en-US.md
View File

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

2
web/docs/guide/ref.md
View File

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

12
web/docs/guide/start.en-US.md
View File

@@ -4,11 +4,11 @@
Click Actions in the warehouse, if Actions have been added, the following interface will be displayed.
![](../../public/add-1.jpg)
![](https://gw.alipayobjects.com/mdn/rms_f97235/afts/img/A*D5dMQLk2pI0AAAAAAAAAAAAAARQnAQ)
Click `New workflow` to add.
![](../../public/add-2.jpg)
![](https://gw.alipayobjects.com/mdn/rms_f97235/afts/img/A*cClPRIW6HKcAAAAAAAAAAAAAARQnAQ)
<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@v2.0.0
uses: actions-cool/issues-helper@v3
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/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#on)
- [Workflow syntax for GitHub Actions](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#about-yaml-syntax-for-workflows)
- `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/free-pro-team@latest/actions/reference/events-that-trigger-workflows)
- Reference [Events that trigger workflows](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows)
- `uses`: Use actions name
- `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](/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)
- `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)
- `body`: Incoming parameters, here means the content of the current comment
### 3. Enable Action

12
web/docs/guide/start.md
View File

@@ -4,11 +4,11 @@
点击仓库的 Actions，若已增加过 Actions，会显示如下界面。
![](../../public/add-1.jpg)
![](https://gw.alipayobjects.com/mdn/rms_f97235/afts/img/A*D5dMQLk2pI0AAAAAAAAAAAAAARQnAQ)
点击 `New workflow` 新增。
![](../../public/add-2.jpg)
![](https://gw.alipayobjects.com/mdn/rms_f97235/afts/img/A*cClPRIW6HKcAAAAAAAAAAAAAARQnAQ)
<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@v2.0.0
uses: actions-cool/issues-helper@v3
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/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#on)
- [GitHub Actions 语法](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#about-yaml-syntax-for-workflows)
- `name`：workflow 名称
- Actions 流程名称，可根据实际情况自定义
- `on`：action 触发条件
- 参考 [工作流触发机制](https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows)
- 参考 [工作流触发机制](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows)
- `uses`：使用 actions 名称
- `uses: actions-cool/issues-helper@v2.0.0`。版本选择请 [参考](/changelog)
- `issues-hepler` 参数
- `actions`：使用功能的名称，**必填**。支持多个，需用逗号隔开，如 `create-comment,close-issue` 表示评论和关闭 issue
- `token`：需拥有 push 权限的人员 token
- 更多 [参考](/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)
- `issue-number`：传入参数，这里表示当前 issue 的编号。如果你对写法疑惑，可 [查看](https://docs.github.com/en/actions/learn-github-actions/contexts#github-context)
- `body`：传入参数，这里表示当前进行评论的内容
### 3. 启用 Action