GitHub Workflow 和 Action 的一些注意事项

GitHub 的 workflow 和 action 存在一些注意事项,总结如下,以供参考

Workflow

on.issues.types

如果需要判断 label,不需要指定 opened,只需要指定 labeled,因为即使 label 是新建时设置的,也会触发 labeled

permissions

如果需要 checkout 当前 repo,需要添加 contents: write,否则会有权限问题

jobs.check.steps.env

如果需要 checkout 当前 repo,需要添加 GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }},否则会有权限问题

Action

List repository issues

API 不仅返回 issues,也会返回 prs,默认 30 条每页,可以指定 labels 来过滤

List pull requests

API 返回所有 pull requests,默认 30 条每页,可以通过 per_pagepage 参数做分页处理,例如:

复制代码
const prs = [];
for (let page = 1; ; page++) {
  const { data } = await octokit.rest.pulls.list({
    ...context.repo,
    base: `refs/heads/main`,
    state: 'open',
    per_page: PER_PAGE,
    page,
  });
  prs.push(...data);
  if (data.length < PER_PAGE) {
    break;
  }
}

Get commit status

API 列出所有 contexts 对应的 state,可以过滤当前的 context

Create commit status

API 用于创建 commit 的 status,可指定 statecontextdescription(作为运行结果显示)

Setting

Require status checks

需要在 Branch protection rule 中的 Protect matching branches 下,勾选 Require status checks to pass before merging

Add required checks

需要将当前的 GitHub action 添加到 Status checks that are required

相关推荐
inhere3 小时前
gookit/goutil v0.7.0 新版本发布:模块调整与功能增强
开源·go·github
用户621024530924 小时前
React:当UI开发从「搬砖」变成「搭乐高」的魔法时刻!
github
用户3918384172114 小时前
Jupyter Notebook:不只是个笔记本,而是你的科学计算驾驶舱!
github
用户255581606904 小时前
Laravel实战指南:从工匠工具到现代PHP开发的艺术
github
用户082699822604 小时前
Docker革命:为什么你的下一个项目必须容器化?🚀
github
用户709991950834 小时前
从零开始认识Elasticsearch:不只是搜索引擎的分布式神器!
github
用户24961588305994 小时前
Express.js:让Node.js搞Web开发爽到飞起!(以及为啥你离不开它)
github
CC码码4 小时前
管理你的多个 Git 密钥(多平台多账号)
git·gitlab·github
CC码码4 小时前
管理你的多个 Git 密钥(单平台多账号)
git·gitlab·github
云原生社区4 小时前
Fabric:为你的命令行安上 AI 管道
人工智能·开源·github