mirror of
https://gitea.com/Lydanne/issues-helper.git
synced 2025-10-14 15:53:55 +08:00
xrkffgg
19
docs/guide/faq.en-US.md
Normal file
19
docs/guide/faq.en-US.md
Normal file
@@ -0,0 +1,19 @@
|
||||
---
|
||||
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.
|
||||
|
||||
## 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/xrkffgg/test-ci) repository
|
||||
3. You can also refer to the warehouse of [online users](/en-US#-who-is-using)
|
||||
|
||||
## So many versions, how to choose?
|
||||
|
||||
You can view the detailed [changelog](/en-US/changelog). The latest releases version is recommended.
|
||||
19
docs/guide/faq.md
Normal file
19
docs/guide/faq.md
Normal file
@@ -0,0 +1,19 @@
|
||||
---
|
||||
toc: menu
|
||||
---
|
||||
|
||||
## 该功能是否收费？
|
||||
|
||||
GitHub Actions 是由 GitHub 免费提供的。其中 `Private` 项目每月有 2000 次的限制，[具体查看](https://github.com/settings/billing)。`Public` 项目无限制。
|
||||
|
||||
## 有没有现成的模板可以参考？
|
||||
|
||||
有的。
|
||||
|
||||
1. 你可以使用这个 [GitHub Actions workflow template](https://github.com/actions-cool/.github) 仓库的模板
|
||||
2. 个人练习和测试 [Actions](https://github.com/xrkffgg/test-ci) 的仓库
|
||||
3. 也可以来 [线上使用者](/#-谁在使用？) 的仓库参照
|
||||
|
||||
## 这么多版本，如何选择？
|
||||
|
||||
你可以查看详细的 [更新日志](/changelog)。推荐采用最新 releases 版本。
|
||||
23
docs/guide/index.en-US.md
Normal file
23
docs/guide/index.en-US.md
Normal file
@@ -0,0 +1,23 @@
|
||||
## Introduction
|
||||
|
||||
The Issues Helper is a GitHub Action that easily helps you automatically manage issues.
|
||||
|
||||
### What are GitHub Actions?
|
||||
|
||||
Automate, customize, and execute your software development workflows right in your repository with GitHub Actions. You can discover, create, and share actions to perform any job you'd like, including CI/CD, and combine actions in a completely customized workflow. [More](https://docs.github.com/en/free-pro-team@latest/actions).
|
||||
|
||||
`issues-helper` is based on this, using GitHub Actions to help you deal with various operations on issues.
|
||||
|
||||
### ✨ Feature
|
||||
|
||||
- 😎 Complete free
|
||||
- 🚀 Fully automatic
|
||||
- 🏖 Hosted on the GitHub server, as long as GitHub is not down, it is not affected
|
||||
|
||||
### ⚡ Feedback
|
||||
|
||||
You are very welcome to try it out and put forward your comments. You can use the following methods:
|
||||
|
||||
- Report bugs or consult with [Issue](https://github.com/actions-cool/issues-helper/issues)
|
||||
- Discuss via [Discussions](https://github.com/actions-cool/issues-helper/discussions)
|
||||
- Submit [Pull Request](https://github.com/actions-cool/issues-helper/pulls) to improve the code of `issues-helper`
|
||||
23
docs/guide/index.md
Normal file
23
docs/guide/index.md
Normal file
@@ -0,0 +1,23 @@
|
||||
## 介 绍
|
||||
|
||||
Issues 助手是一个轻松帮你自动管理 issues 的 GitHub Action。
|
||||
|
||||
### GitHub Actions 是什么？
|
||||
|
||||
GitHub Actions 是由 GitHub 官方提供在存储库中自动化、自定义和执行软件开发工作流程。您可以发现，创建和共享操作以执行所需的任何工作（包括CI / CD），并在完全定制的工作流程中组合操作。[更多介绍](https://docs.github.com/en/free-pro-team@latest/actions)。
|
||||
|
||||
`issues-helper` 就是以此为基础，利用 GitHub Actions 来帮你处理各种关于 issue 方面的操作。
|
||||
|
||||
### ✨ 特性
|
||||
|
||||
- 😎 完全免费
|
||||
- 🚀 全自动操作
|
||||
- 🏖 托管于 GitHub 服务器，只要 GitHub 不宕机，它就不受影响
|
||||
|
||||
### ⚡ 反馈
|
||||
|
||||
非常欢迎你来尝试使用，并提出意见，你可以通过以下方式：
|
||||
|
||||
- 通过 [Issue](https://github.com/actions-cool/issues-helper/issues) 报告 bug 或进行咨询
|
||||
- 通过 [Discussions](https://github.com/actions-cool/issues-helper/discussions) 进行讨论
|
||||
- 提交 [Pull Request](https://github.com/actions-cool/issues-helper/pulls) 改进 `issues-helper` 的代码
|
||||
83
docs/guide/ref.en-US.md
Normal file
83
docs/guide/ref.en-US.md
Normal file
@@ -0,0 +1,83 @@
|
||||
---
|
||||
toc: menu
|
||||
---
|
||||
|
||||
## 📍 `token`
|
||||
|
||||
Need to have the person token with push permission.
|
||||
|
||||
- [Personal token application](https://github.com/settings/tokens)
|
||||
- Need to check `Full control of private repositories`
|
||||
- Project add secrets
|
||||
- Select settings, select secrets, select `New repository secret`
|
||||
- `Name` is the same as in actions
|
||||
- `Value` fill in the token just applied by the individual
|
||||
|
||||
When the token is not filled in actions or the corresponding secrets are not added to the project, it will default to `github-actions-bot`. [More](https://docs.github.com/en/free-pro-team@latest/actions/reference/authentication-in-a-workflow).
|
||||
|
||||
## 📍 GitHub Docs
|
||||
|
||||
- [Workflow syntax for GitHub Actions](https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#on)
|
||||
- [Events that trigger workflows](https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows)
|
||||
|
||||
## 📍 `outputs` use
|
||||
|
||||
```yml
|
||||
- name: Create issue
|
||||
uses: actions-cool/issues-helper@v1
|
||||
id: createissue
|
||||
with:
|
||||
actions: 'create-issue'
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
- name: Check outputs
|
||||
run: echo "Outputs issue_number is ${{ steps.createissue.outputs.issue-number }}"
|
||||
```
|
||||
|
||||
[More](https://docs.github.com/en/free-pro-team@latest/actions/creating-actions/metadata-syntax-for-github-actions#outputs).
|
||||
|
||||
## 📍 `includes` check rules
|
||||
|
||||
```js
|
||||
"title-includes": 'x1,x2'
|
||||
|
||||
x1
|
||||
x2
|
||||
|
||||
"x1y3y2" true
|
||||
"y2 x1" true
|
||||
"x2" true
|
||||
"x3" false
|
||||
```
|
||||
|
||||
```js
|
||||
"title-includes": 'x1,x2/y1,y2'
|
||||
|
||||
x1 + y1
|
||||
x2 + y1
|
||||
x1 + y2
|
||||
x2 + y2
|
||||
|
||||
"x1y3y2" true
|
||||
"y2 x1" true
|
||||
"1x2y" false
|
||||
"x1" false
|
||||
```
|
||||
|
||||
## 📍 `Reactions` Type
|
||||
|
||||
| content | emoji |
|
||||
| -- | -- |
|
||||
| `+1` | 👍 |
|
||||
| `-1` | 👎 |
|
||||
| `laugh` | 😄 |
|
||||
| `confused` | 😕 |
|
||||
| `heart` | ❤️ |
|
||||
| `hooray` | 🎉 |
|
||||
| `rocket` | 🚀 |
|
||||
| `eyes` | 👀 |
|
||||
|
||||
For details, please [view](https://docs.github.com/en/free-pro-team@latest/rest/reference/reactions).
|
||||
|
||||
## 📍 `comment-id`
|
||||
|
||||
Click the `···` icon in the upper right corner of a comment, select `Copy link`, and the number at the end of the url is `comment_id`.
|
||||
83
docs/guide/ref.md
Normal file
83
docs/guide/ref.md
Normal file
@@ -0,0 +1,83 @@
|
||||
---
|
||||
toc: menu
|
||||
---
|
||||
|
||||
## 📍 `token` 说明
|
||||
|
||||
需拥有 push 权限的人员 token。
|
||||
|
||||
- [个人 token 申请](https://github.com/settings/tokens)
|
||||
- 需勾选 `Full control of private repositories`
|
||||
- 项目添加 secrets
|
||||
- 选择 settings，选择 secrets，选择 `New repository secret`
|
||||
- `Name` 与 actions 中保持一致
|
||||
- `Value` 填写刚才个人申请的 token
|
||||
|
||||
当 actions 不填写 token 时，或项目未添加对应 secrets 时，会默认为 `github-actions-bot`。[更多查看](https://docs.github.com/en/free-pro-team@latest/actions/reference/authentication-in-a-workflow)。
|
||||
|
||||
## 📍 GitHub 相关文档
|
||||
|
||||
- [GitHub Actions 语法](https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions#on)
|
||||
- [工作流触发机制](https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows)
|
||||
|
||||
## 📍 `outputs` 使用
|
||||
|
||||
```yml
|
||||
- name: Create issue
|
||||
uses: actions-cool/issues-helper@v1
|
||||
id: createissue
|
||||
with:
|
||||
actions: 'create-issue'
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
- name: Check outputs
|
||||
run: echo "Outputs issue_number is ${{ steps.createissue.outputs.issue-number }}"
|
||||
```
|
||||
|
||||
[更多查看](https://docs.github.com/en/free-pro-team@latest/actions/creating-actions/metadata-syntax-for-github-actions#outputs)。
|
||||
|
||||
## 📍 `includes` 校验规则
|
||||
|
||||
```js
|
||||
"title-includes": 'x1,x2'
|
||||
|
||||
x1
|
||||
x2
|
||||
|
||||
"x1y3y2" true
|
||||
"y2 x1" true
|
||||
"x2" true
|
||||
"x3" false
|
||||
```
|
||||
|
||||
```js
|
||||
"title-includes": 'x1,x2/y1,y2'
|
||||
|
||||
x1 + y1
|
||||
x2 + y1
|
||||
x1 + y2
|
||||
x2 + y2
|
||||
|
||||
"x1y3y2" true
|
||||
"y2 x1" true
|
||||
"1x2y" false
|
||||
"x1" false
|
||||
```
|
||||
|
||||
## 📍 `Reactions` 类型
|
||||
|
||||
| content | emoji |
|
||||
| -- | -- |
|
||||
| `+1` | 👍 |
|
||||
| `-1` | 👎 |
|
||||
| `laugh` | 😄 |
|
||||
| `confused` | 😕 |
|
||||
| `heart` | ❤️ |
|
||||
| `hooray` | 🎉 |
|
||||
| `rocket` | 🚀 |
|
||||
| `eyes` | 👀 |
|
||||
|
||||
如需详细了解，可 [查看](https://docs.github.com/en/free-pro-team@latest/rest/reference/reactions)。
|
||||
|
||||
## 📍 `comment-id`
|
||||
|
||||
点击某个评论右上角 `···` 图标，选择 `Copy link`，url 末尾数字即是 `comment_id`。
|
||||
67
docs/guide/start.en-US.md
Normal file
67
docs/guide/start.en-US.md
Normal file
@@ -0,0 +1,67 @@
|
||||
## Quick start
|
||||
|
||||
### 1. New Action
|
||||
|
||||
Click Actions in the warehouse, if Actions have been added, the following interface will be displayed.
|
||||
|
||||
|
||||
|
||||
Click `New workflow` to add.
|
||||
|
||||
|
||||
|
||||
<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>.
|
||||
</Alert>
|
||||
|
||||
### 2. Edit Action
|
||||
|
||||
Actions storage address is fixed, unified as `/.github/workflows/xx.yml`.
|
||||
|
||||
Let's take the example of the home page and explain it in detail. The corresponding scenario is: when an issue adds the `help wanted` tag, the system will automatically comment.
|
||||
|
||||
```yml
|
||||
name: Issue Reply
|
||||
|
||||
on:
|
||||
issues:
|
||||
types: [labeled]
|
||||
|
||||
jobs:
|
||||
reply-helper:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: help wanted
|
||||
if: github.event.label.name == 'help wanted'
|
||||
uses: actions-cool/issues-helper@v1.2
|
||||
with:
|
||||
actions: 'create-comment'
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
issue-number: ${{ github.event.issue.number }}
|
||||
body: |
|
||||
Hello @${{ github.event.issue.user.login }}. We totally like your proposal/feedback, welcome PR。
|
||||
|
||||
你好 @${{ 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)
|
||||
- `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)
|
||||
- `uses`: Use actions name
|
||||
- `uses: actions-cool/issues-helper@v1.2`。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)
|
||||
- `body`: Incoming parameters, here means the content of the current comment
|
||||
|
||||
### 3. Enable Action
|
||||
|
||||
When you finish writing and submit to the master branch, you can automatically enable the workflow, and the trigger conditions follow the definition of `on`.
|
||||
|
||||
😏 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](/en-US/base) and [Advanced](/en-US/advanced) for flexible reference.
|
||||
67
docs/guide/start.md
Normal file
67
docs/guide/start.md
Normal file
@@ -0,0 +1,67 @@
|
||||
## 快速开始
|
||||
|
||||
### 1. 新建 Action
|
||||
|
||||
点击仓库的 Actions，若已增加过 Actions，会显示如下界面。
|
||||
|
||||
|
||||
|
||||
点击 `New workflow` 新增。
|
||||
|
||||
|
||||
|
||||
<Alert type="success">
|
||||
你可以点击 <Badge>set up a workflow yourself</Badge> 新增一个自定义 action，也可以根据模板来套用新增一个 action。<a target="_blank" href="https://github.com/actions-cool/.github">模板使用</a>。
|
||||
</Alert>
|
||||
|
||||
### 2. 编写 Action
|
||||
|
||||
Actions 存放地址是固定的，统一为 `/.github/workflows/xx.yml`。
|
||||
|
||||
下面拿首页的例子详细说明下。对应场景为：当一个 issue 新增 `help wanted` 标签时，系统会自动进行评论。
|
||||
|
||||
```yml
|
||||
name: Issue Reply
|
||||
|
||||
on:
|
||||
issues:
|
||||
types: [labeled]
|
||||
|
||||
jobs:
|
||||
reply-helper:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: help wanted
|
||||
if: github.event.label.name == 'help wanted'
|
||||
uses: actions-cool/issues-helper@v1.2
|
||||
with:
|
||||
actions: 'create-comment'
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
issue-number: ${{ github.event.issue.number }}
|
||||
body: |
|
||||
Hello @${{ github.event.issue.user.login }}. We totally like your proposal/feedback, welcome PR。
|
||||
|
||||
你好 @${{ 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)
|
||||
- `name`：workflow 名称
|
||||
- Actions 流程名称，可根据实际情况自定义
|
||||
- `on`：action 触发条件
|
||||
- 参考 [工作流触发机制](https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows)
|
||||
- `uses`：使用 actions 名称
|
||||
- `uses: actions-cool/issues-helper@v1.2`。版本选择请 [参考](/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)
|
||||
- `body`：传入参数，这里表示当前进行评论的内容
|
||||
|
||||
### 3. 启用 Action
|
||||
|
||||
当你完成编写完成提交到主分支后，即可自动启用该 workflow，触发条件遵循 `on` 的定义。
|
||||
|
||||
😏 相信到这里你已经对 `如何使用` 有了大概的了解，是不是想快点尝试一下。
|
||||
|
||||
下面请在 [基 础](/base) 和 [进 阶](/advanced) 查看你需要的功能，灵活参考。
|
||||
Reference in New Issue
Block a user