常常玩 GitHub 的童鞋想必对 Issues 都不生疏。它是连贯维护者和使用者的一个重要形式。
对于维护者:
- 能够收集、解决产品的 Bug 和 新个性。
- 建设以产品为核心的社区。
- 依据 issue 可定位产品薄弱环节和将来走向。
对于使用者:
- 能够通过 issue 征询应用问题,也可查问以往 issue 来解决本人遇到的问题。
- 与不同的使用者交流经验,也可能会是国际友人。
- 与维护者交换,并可参加到产品的开发中来。
所以常常会看到各大我的项目有成千上百的 Issues 待处理,而且每天都在增长。短暂以往就给维护者带来了一个很的问题: 这么多 Issues,如何无效的进行自动化治理呢?
接下来,容我介绍下,明天的配角:
Issues 助手 —— 一个轻松帮你主动治理 issues 的 GitHub Action
GitHub Action 是什么?
GitHub Actions 是由 GitHub 官网提供在存储库中自动化、自定义和执行软件开发工作流程。您能够发现,创立和共享操作以执行所需的任何工作(包含 CI / CD),并在齐全定制的工作流程中组合操作。
issues-helper
就是以此为根底,利用 GitHub Actions 来帮你解决各种对于 issue 方面的操作。
谁在应用?
- ant-design
- ant-design-vue
- umi
- dumi
- vue-request
✨ 个性
- ???? 完全免费
- ???? 全自动操作
- ???? 托管于 GitHub 服务器,只有 GitHub 不宕机,它就不受影响
???? 疾速开始
1. 新建 Action
点击仓库的 Actions,若已减少过 Actions,会显示如下界面。
点击 New workflow
新增。
你能够点击 set up a workflow yourself
新增一个自定义 action,也能够依据模板来套用新增一个 action。模板应用。
2. 编写 Action
Actions 寄存地址是固定的,对立为 /.github/workflows/xx.yml
。
上面拿首页的例子具体阐明下。对应场景为:当一个 issue 新增 help wanted 标签时,零碎会主动进行评论。
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。
具体参数查看。
3. 启用 Action
当你实现编写实现提交到主分支后,即可主动启用该 workflow,触发条件遵循 on 的定义。
???? 性能列表
目前已增加的性能,基本上笼罩了大部分通用的 issue 应用场景。具体应用及参数可来在线教程里查看。
⭐ 基 础
- add-assignees
- add-labels
- close-issue
- create-comment
- create-issue
- delete-commen
- lock-issue
- mark-duplicate
- open-issue
- remove-assignees
- remove-labels
- set-labels
- unlock-issue
- update-comment
- update-issue
- welcome
⭐ 进 阶
- check-inactive
- check-issue
- close-issues
- find-comments
- lock-issues
结语
欢送各位尝试,同时在应用过程中遇到问题,欢送通过如下形式进行反馈~
- 通过 Issue 报告 bug 或进行征询
- 通过 Discussions 进行探讨
- 提交 Pull Request 改良
issues-helper
的代码
最初,祝大家 新年快乐 ????