如何使用 Github Action 管理 Issue

本文作者为 360 奇舞团前端开发工程师 Daryl

前言

8dff5425a37a841be58635a469034ee2.png很多小伙伴打开 github 上的仓库都只使用Code查看代码，或者只是把 github 当成一个代码仓库，但是 github 还提供了很多好用的功能。

其中，GitHub Action就是一个很好用的功能，本文将通过几个管理Issue的示例带大家了解GitHub Action:

什么是 Github Action

github 给所有用户都提供了临时可用的虚拟机， 我们通过创建 github action 工作流来使用这个虚拟机. 我们可以使用它来实现自动化部署、自动化测试、代码检查、管理 Issues...

使用步骤

在学习之前还需要准备一些资料:

  1. Github Action文档

  2. 官方仓库中有很多可以复用的 Action， 通过uses字段引用就可以直接使用了。

  3. 阮一峰的YAML 教程；

也推荐大家使用Vscode GitHub Action插件，这个插件在登录后可以用来做语法校验，还能查看运行过的记录。

除了这些资料之外还有些基础概念需要了解:

  1. 事件: 在工作流中可以监听 github 的一些事件， 在事件触发后执行我们定义的工作流;

  2. 上下文: github 上下文包含有关工作流运行和触发运行的事件的信息，可以读取环境变量中的大多数 github 上下文数据，并允许我们通过变量访问这些数据。

  3. 变量: 变量提供了一种存储和重用非敏感配置信息的方法。 可以将任何配置数据（如编译器标志、用户名或服务器名称）存储为变量。 变量在运行工作流的运行器计算机上插值。 在操作或工作流步骤中运行的命令可以创建、读取和修改变量。

  4. 表达式: 可以使用表达式来运算工作流程文件中的变量。

  5. 秘钥: 普通变量中存储的信息并不安全，很容易泄露，一些需要保密的信息就可以存储到秘钥中。

如果不想去从头学习yml语法， 可以先了解一些yml的基础用法:

  • 大小写敏感

  • 使用缩进表示层级关系

  • 缩进时不允许使用 Tab 键，只允许使用空格。

  • 缩进的空格数目不重要，只要相同层级的元素左侧对齐即可

下面开始介绍 GitHub Action 的用法

使用 github Action ，第一步需要在项目根目录下创建.github/workflows文件夹， 所有的工作流文件都要放到这个文件夹，当事件触发时会自动执行;fd320390b995a60d40181b200cef1eed.png

大家可以通过这个 workflow 文件示例来简单了解下各个字段的用处:

name: build # workflow的名称，缺省时会使用文件名
on: # workflow监听事件push # 具体的事件branches: # 在这些分支上才会触发- main- 'mona/octocat'- 'releases/**'
jobs: # 执行的工作的集合build: # ‘build’是一个自定义的工作的id<job_id>name: rele # 当前工作的名称runs-on: ubuntu-latest # 因为工作实际是运行在虚拟机上的，runs-on就是指定虚拟机的版本steps: # steps是步骤的集合- name: checkout # name是指定当前工作的名称 在workflow（工作流）文件的steps中，每个用‘-’代替缩进视为一个步骤的开始uses: actions/checkout@v2 # uses字段是选择一个可以直接复用的action，并且在github action store中的action可以直接使用，不需要下载- name: setting envid: setting # id 是步骤的唯一标识符，可以使用 id 在上下文中引用该步骤env: # 设置环境变量NODEV: 18run: echo "nodev=$NODEV" >> $GITHUB_OUTPUT # run字段会在命令行执行一条命令，这个命令是将"nodev=18"写入到$GITHUB_OUTPUT，这样可以为'output'添加test属性值为test1，详情参考- name: addnodeuses: actions/setup-node@v3 # 使用node环境with: # 为‘uses’使用的action传递参数node-version: ${{steps.setting.output.nodev}} # 使用上面设置的变量

在编写工作流文件之前有两件事要做:

一. 可以在 github 或者 github action 的仓库里查找公用 action.这样可以减少很多工作量:

常用的 action 有:

  • checkout: 帮我们自动把项目克隆到虚拟机上

  • Setup Node: 自动安装 node

  • issues-helper: 辅助处理 issues

二. 如果没有设置 action 的读写权限，第一次运行会报错:27be5e8c4bf2d81957c5d6cefbbd7ec4.png设置权限:52bbe2c1d8090cd1dbc378dd8d5caeba.png

再次运行:

2346f4f49bc77397a84bf140f4c61a7a.png
Alt text

下面通过一些具体示例给大家介绍一些Github Action的用法:

  • 检查 issues 格式是否规范， 并关闭不规范 issue

    在开源项目中，很多人都会提一些 issue。为了方便开发者查看，可以上传 issue 模版，并且根据模版校验 issue 格式，然后关闭不符合模板格式的 issue。

    在这个示例主要介绍脚本执行怎么向github上下文注入变量，我们可以参考github 设置环境变量的教程.

    这个脚本可以配合.github/ISSUE_TEMPLATE文件夹中的 issue 模板使用的，将.md文件放入这个文件夹中就可以作为 Issue 的默认模板;

    9c7a80f20f429e4aa7c3852d33033560.png
    Alt text

    选择 Bug 提交将使用这个模板:

    ---
name: Bug 提交
about: 使用此模板来提交一个 bug。
---# BUG 提交## 描述该错误简明扼要地描述一下这个错误是什么。
可以添加屏幕截图以帮助解释你的问题。## 复现这个 BUG 的复现步骤:1. ...
2. ...
3. ......或者添加录屏链接## 运行结果预期的结果:
... ...
实际的结果:
... ...## 运行环境信息- Device: [e.g. 设备名称]
- OS: [e.g. 操作系统]
- Browser [e.g. 浏览器]
- Version [e.g. 浏览器版本]## 其它在此添加关于问题的任何其它信息。

    选择功能请求将使用这个模板:

    ---
name: 功能请求
about: 使用此模板来提交一个功能请求。
---# 功能请求## 你期望添加什么样的功能?你期望新增功能的描述，或者示例链接。

    检查 issue 格式的脚本:

    // action_script/lintIssue.js
const issueText = process.env.ISSUEconst textSplit = issueText.split(`
`).map((str) => str.replace('\r', ''))
const bugHandle = () => {// 缺少错误描述const desIndex = textSplit.indexOf('## 描述该错误')if (desIndex === -1) {console.log('ISSUE_CHECK_RESULT=unqualified')console.log('ISSUE_CHECK_REPLY=缺少错误描述')return}const repeatIndex = textSplit.indexOf('## 复现')if (repeatIndex === -1) {console.log('ISSUE_CHECK_RESULT=unqualified')console.log('ISSUE_CHECK_REPLY=缺少复现步骤')return}const desContent = textSplit.slice(desIndex + 1, repeatIndex).join('').replaceAll(' ', '')if (!desContent) {console.log('ISSUE_CHECK_RESULT=unqualified')console.log('ISSUE_CHECK_REPLY=缺少错误描述')return}// 缺少复现步骤const runResultIndex = textSplit.indexOf('## 运行结果')if (runResultIndex === -1) {console.log('ISSUE_CHECK_RESULT=unqualified')console.log('ISSUE_CHECK_REPLY=缺少运行结果')return}const repeatContent = textSplit.slice(repeatIndex + 1, runResultIndex).join('').replaceAll(' ', '')if (!repeatContent) {console.log('ISSUE_CHECK_RESULT=unqualified')console.log('ISSUE_CHECK_REPLY=缺少复现步骤')return}// 运行结果const envIndex = textSplit.indexOf('## 运行环境信息')if (envIndex === -1) {console.log('ISSUE_CHECK_RESULT=unqualified')console.log('ISSUE_CHECK_REPLY=缺少运行环境信息')return}const resContent = textSplit.slice(runResultIndex + 1, envIndex).join('').replaceAll(' ', '')if (!resContent) {console.log('ISSUE_CHECK_RESULT=unqualified')console.log('ISSUE_CHECK_REPLY=缺少运行结果')return}// 运行环境信息const otherIndex = textSplit.indexOf('## 其他') || textSplit.length + 1const envContent = textSplit.slice(envIndex + 1, otherIndex)const envReg = /\[e\.g\..{5,}\]/let hasDevice = falselet hasOS = falselet hasBrowser = falselet hasVersion = falselet errMsg = ''envContent.forEach((str) => {if (str.match(envReg)) {if (str.includes('Device')) {hasDevice = true} else if (str.includes('OS')) {hasOS = true} else if (str.includes('Browser')) {hasBrowser = true} else if (str.includes('Version')) {hasVersion = true}}})if (!hasDevice) {errMsg += '缺少设备名称;'} else if (!hasOS) {errMsg += '缺少操作系统名称;'} else if (!hasBrowser) {errMsg += '缺少浏览器名称;'} else if (!hasVersion) {errMsg += '缺少浏览器版本;'}if (errMsg) {console.log('ISSUE_CHECK_RESULT=unqualified')console.log('ISSUE_CHECK_REPLY=' + errMsg)} else {console.log('ISSUE_CHECK_RESULT=pass')}
}const featureHandle = () => {// 缺少错误描述const desIndex = textSplit.indexOf('## 你期望添加什么样的功能?')const desContent = textSplit.slice(desIndex + 1, textSplit.length).join('').replaceAll(' ', '').replaceAll('\n', '')if (desIndex === -1 || desIndex === textSplit.length - 1 || !desContent) {console.log('ISSUE_CHECK_RESULT=unqualified')console.log('ISSUE_CHECK_REPLY=缺少功能描述')return} else {console.log('ISSUE_CHECK_RESULT=pass')}
}
if (textSplit[0] === '# BUG 提交') {console.log('ISSUE_CHECK_TYPE=bug')bugHandle()
} else if (textSplit[0] === '# 功能请求') {console.log('ISSUE_CHECK_TYPE=feature')featureHandle()
} else {console.log('ISSUE_CHECK_TYPE=invalid')console.log('ISSUE_CHECK_RESULT=unqualified')console.log('ISSUE_CHECK_REPLY=这不是一个BUG或者功能请求')
}

    工作流示例文件:

    # .github/workflows/close-non_standard-issue.ymlname: close non-standard issueson:issues:types: [opened, edited] # issue 打开或者编辑后jobs:close-issue:runs-on: ubuntu-latestenv:ISSUE: ${{ github.event.issue.body }}steps:- name: 'checkout'uses: actions/checkout@v3- name: Setup nodeuses: actions/setup-node@v3with:node-version: 18registry-url: https://registry.npmjs.com/- name: lint shrun: node ./action_script/lintIssue.js  >> "$GITHUB_ENV" # 设置自定义github变量- name: add-labeluses: actions-cool/issues-helper@v3with:actions: 'add-labels'token: ${{ secrets.GITHUB_TOKEN }}issue-number: ${{ github.event.issue.number }}labels: ${{env.ISSUE_CHECK_TYPE}}- name: 'close-issue'if: ${{env.ISSUE_CHECK_RESULT == 'unqualified'}}uses: actions-cool/issues-helper@v3with:actions: 'close-issue'token: ${{ secrets.GITHUB_TOKEN }}body: |Hello @${{ github.event.issue.user.login }}.你的Issue因为下面的原因被关闭了:${{env.ISSUE_CHECK_REPLY}}

  • 如果是做一些简单的校验可以使用 actions-cool/issues-helper@v3 中的 check-issue:

    这个示例主要是演示运算符的使用:

    name: add label of non_standard Issueon:issues:types: [opened, edited]jobs:check-issue:runs-on: ubuntu-lateststeps:- id: check-issue # 必须使用id,不然不能访问到运行结果uses: actions-cool/issues-helper@v3with:actions: "check-issue"token: ${{ secrets.GITHUB_TOKEN }}issue-number: ${{ github.event.issue.number }}title-includes: "【,BUG,】" # 标题包含['【','BUG','】']body-includes: "问题描述,问题复现步骤" # 内容包含 ['问题描述','问题复现步骤']- name: add-labeluses: actions-cool/issues-helper@v3if: ${{steps.check-issue.outputs.check-result == 'true'}} # 如果判断条件是 'true', 继续运行with:actions: "add-labels"token: ${{ secrets.GITHUB_TOKEN }}issue-number: ${{ github.event.issue.number }} # 当前Issue的编号labels: "bug" # 添加标签: 'bug'

  • 关闭缺少复现步骤的 Issue

    有些 Issue 虽然通过了格式检查，但是还会缺少一些步骤，或者不能复现。我们可以手动添加 label，并且在三天不活跃的情况下自动关闭。

    这个示例主要是介绍怎么执行定时任务:

    # .github/workflows/close-inactive-issue.yml
name: close inactive issue
on:schedule:- cron: "00 12,00,18 * * *" # 在每天标准时间的12：00/00:00/18:00 执行jobs:check-inactive-info:runs-on: ubuntu-lateststeps:- name: need reproductionuses: actions-cool/issues-helper@v3with: # 关闭有label是'need reproduction'，并且三天不活跃的Issueactions: "close-issues"token: ${{ secrets.GITHUB_TOKEN }}labels: "need reproduction"inactive-day: 3

  • 添加标签时自动评论、关闭 BUG

    有些常用的评论内容，或者用的比较多的操作，每次使用都比较繁琐。我们可以在添加标签的时候自动评论，或者执行对应的操作。比如：自动评论欢迎词，关闭手动筛选出来不符合 issue 模版的 issue 并告诉用户原因。

    这个示例是介绍在.yml文件中长文本的写法

    name: Issue Labeled
# .github/workflows/issue-labeled.yml
# 在issue添加标签后回复对应的评论
on:issues:types: [labeled]jobs:reply-labeled:runs-on: ubuntu-lateststeps:# 需要帮助- name: contribution welcomeif: github.event.label.name == 'help wanted'uses: actions-cool/issues-helper@v3with:actions: "create-comment"issue-number: ${{ github.event.issue.number }}body: |你好 @${{ github.event.issue.user.login }}，我们完全同意你的提议/反馈，欢迎直接在此仓库 [创建一个 Pull Request](https://github.com/NI-Web-Infra-Team/vue3-template/pulls) 来解决这个问题。请将 Pull Request 发到 `dev` 分支，提供改动所需相应的 changelog、TypeScript 定义、测试用例、文档等，并确保 CI 通过，我们会尽快进行 Review，提前感谢和期待您的贡献。# 补充复现流程- name: need reproductionif: github.event.label.name == 'need reproduction'uses: actions-cool/issues-helper@v3with:actions: "create-comment"issue-number: ${{ github.event.issue.number }}body: |你好 @${{ github.event.issue.user.login }}， 我们需要你提供一个在线的重现实例以便于我们帮你排查问题。可以通过点击 [此处](https://codepen.io/pen/) 创建或者提供一个最小化的 GitHub 仓库。3 天内未跟进此 issue 将会被自动关闭。- name: invalidif: github.event.label.name == 'invalid'uses: actions-cool/issues-helper@v3with:actions: "create-comment, close-issue"issue-number: ${{ github.event.issue.number }}body: |你好 @${{ github.event.issue.user.login }}，为了能够进行高效沟通，我们对 issue 有一定的格式要求，你的 issue 因为不符合要求而被自动关闭。你可以通过模板来创建 issue 以方便我们定位错误。谢谢配合！

  • 使用 ftp 自动部署

    如果有在公网的服务器，可以在编译完成后打包发送到自己的服务器实现自动部署。 在 github 中搜索 ftp action， 第一个 SamKirkland/FTP-Deploy-Action 就是将 github 项目部署到 ftp 服务器的:

    最后这个示例介绍的是怎么设置秘钥:

    name: ftp send fileon: workflow_dispatch # 手动部署jobs:web-deploy:name: Deployruns-on: ubuntu-lateststeps:- name: Get latest codeuses: actions/checkout@v3 # 拉取项目代码- name: Setup nodeuses: actions/setup-node@v3 # 安装nodewith:node-version: 18registry-url: https://registry.npmjs.com/- name: install packagerun: npm i # 安装项目依赖- name: buildrun: npm run build # 编译- name: packrun: zip -q -r dist.zip ./dist # 打包成zip- name: Sync filesuses: SamKirkland/FTP-Deploy-Action@v4.3.4 # 上传到ftp服务器with:server: 10.52.0.x # 服务器地址username: testusername # 服务器用户名password: ${{ secrets.ftp_password }} # 服务器密码

    • 设置在 action 中可以访问的秘钥

      服务器密码secrets.ftp_password，就是在 github 中设置的秘钥:b3d99db7d108040500fff6d37fa69e6e.png867d509abfe9593c34cc56843d76a50d.pngb7c069e7c56c2492b06faab1c25cedc2.png

结语

通过使用 Github Action 来管理 Issue，可以有效的提高生产力和效率，在自动化、协作、代码质量管理等方面都有提升，并帮助我们更好地组织和管理问题。文章篇幅有限，我们暂且介绍到这里，感兴趣的小伙伴们可以再自行探索。

- END -

关于奇舞团

奇舞团是 360 集团最大的大前端团队，代表集团参与 W3C 和 ECMA 会员（TC39）工作。奇舞团非常重视人才培养，有工程师、讲师、翻译官、业务接口人、团队 Leader 等多种发展方向供员工选择，并辅以提供相应的技术力、专业力、通用力、领导力等培训课程。奇舞团以开放和求贤的心态欢迎各种优秀人才关注和加入奇舞团。

bcac0ea2df12f76a06b72b602213b300.png

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.hqwc.cn/news/180261.html

如若内容造成侵权/违法违规/事实不符，请联系编程知识网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

双点重发布路由策略实验

双点重发布路由策略实验

任务&IP分配如下&#xff1a; 双点重发布实验 第一步&#xff1a;配置IP地址&环回地址 以R1为例&#xff0c;R2、R3、R4同理 interface GigabitEthernet 0/0/0 ip address 12.0.0.1 24 interface GigabitEthernet 0/0/1 ip address 13.0.0.1 24 interface LookBack …
阅读更多...
[Unity3D] C# 十进制、二进制、十六进制 之间进制的转换

[Unity3D] C# 十进制、二进制、十六进制 之间进制的转换

//十进制 --> 二进制 int data 100; string bin Convert.ToString(data, 2); // “1100100”//十进制 --> 十六进制 int data 100; string hex “”;hex Convert.ToString(data, 16); // “64” hex “0X” Convert.ToString(data, 16); // “0X64” hex string.…
阅读更多...
ubuntu下C++调用matplotlibcpp进行画图(超详细)

ubuntu下C++调用matplotlibcpp进行画图(超详细)

目录 一、换源 二、安装必要的软件 三、下载matplotlibcpp 四、下载anaconda 1.anaconda下载 2.使用anaconda配置环境 五、下载CLion 1.下载解压CLion 2.替换jbr文件夹 3.安装CLion 4.激活CLion 5.CLion汉化 6.Clion配置 六、使用CLion运行 七、总结 我的环…
阅读更多...
demo(二)eurekaribbon----服务注册、提供与消费

demo(二)eurekaribbon----服务注册、提供与消费

前一篇实现了服务注册中心的搭建&#xff0c;并提供服务注册到注册中心上。在之前的基础上&#xff0c;实现服务消费。 一、相关介绍 1、RestTemplate工具 2、LoadBalanced注解 二、ribbon示例&#xff1a; 先启动eureka-service注册中心&#xff0c;再将eureka-client修改…
阅读更多...
零小时零信任：数据标记如何加速实施

零小时零信任：数据标记如何加速实施

现在是零信任的零小时。 虽然这个概念已经存在多年&#xff0c;但现在联邦政府实施它的时间已经紧迫。 拜登政府备忘录被誉为以战斗速度安全交付关键任务数据的解决方案&#xff0c;要求联邦机构在 2024 财年年底前实现具体的零信任安全目标。 此外&#xff0c;国防部正在努…
阅读更多...
JavaScript的函数的形参与实参是怎么回事

JavaScript的函数的形参与实参是怎么回事

0 写在前面 此文给小白看的&#xff0c;如果不是可以直接关闭 1 讲解 例如JavaScript中定义函数 //定义函数 function 方法名(形参){方法体-->使用形参}//使用函数 方法名字(实参)具体干了什么呢&#xff1f;此处以伪代码举例 //定义函数 function eat(A,B){A 去 B 家吃…
阅读更多...
iOS性能优化

iOS性能优化

了解屏幕成像的原理。 有一个电子枪然后在很多横轴方向上 发射电子&#xff0c;不同横轴的电子枪根据显示器中的硬件时钟产生一系列的定时信号&#xff0c;以此来让电子以不同的时间发射出去 这些电子一瞬间的运动形成了一帧动画。 CPU优化&#xff1a; 1.文本计算优化 如果一…
阅读更多...
【Web开发】基于 Jekyll 中的 Chirpy 模板搭建博客网站（一）：成功经验篇

【Web开发】基于 Jekyll 中的 Chirpy 模板搭建博客网站（一）：成功经验篇

基于 Jekyll 中的 Chirpy 模板搭建博客网站&#xff08;一&#xff09;&#xff1a;成功经验篇 1.Jekyll 介绍2.Chirpy 介绍3.安装步骤3.1 Prerequisites3.2 Installation3.2.1 Creating a New Site3.2.2 Installing Dependencies 3.3 Usage3.3.1 Configuration3.3.2 Running L…
阅读更多...
使用C#插件Quartz.Net定时执行CMD任务工具2

使用C#插件Quartz.Net定时执行CMD任务工具2

目录 创建简易控制台定时任务步骤完整程序 创建简易控制台定时任务 创建winform的可以看&#xff1a;https://blog.csdn.net/wayhb/article/details/134279205 步骤 创建控制台程序 使用vs2019新建项目&#xff0c;控制台程序&#xff0c;使用.net4.7.2项目右键&#xff08…
阅读更多...
队列的实现---超详细

队列的实现---超详细

队列的实现—超详细 文章目录 队列的实现---超详细一、队列的模型二、代码实现以及测试用例①队列初始化②入队③出队④输出队头⑤输出队尾⑥判断队列是否为空⑦队列的长度⑧队列的销毁⑨测试用例 一、队列的模型 队列&#xff1a;只允许在一端进行插入数据操作&#xff0c;在…
阅读更多...
过滤器模式 rust和java的实现

过滤器模式 rust和java的实现

文章目录 过滤器模式实现 过滤器模式实现javarustjavarust rust代码仓库 过滤器模式 过滤器模式&#xff08;Filter Pattern&#xff09;或标准模式&#xff08;Criteria Pattern&#xff09;是一种设计模式&#xff0c;这种模式允许开发人员使用不同的标准来过滤一组对象&…
阅读更多...
Unity中Shader矩阵的乘法

Unity中Shader矩阵的乘法

文章目录 前言一、矩阵乘以标量二、矩阵和矩阵相乘1、第一个矩阵的列数必须 与 第二个矩阵的行数相等&#xff0c;否则无法相乘&#xff01;2、相乘的结果矩阵&#xff0c;行数由第一个矩阵的行数决定&#xff0c;列数由第二个矩阵的列数决定&#xff01; 三、单位矩阵四、矩阵…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023