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

相关推荐
Tisfy4 小时前
Github - 如何提交一个带有“verified”标识的commit
git·ssh·github·ssh key·gpg
tekin5 小时前
github codespaces推送镜像时unauthorized: access token has insufficient scopes 解决方法
docker·github·login·codespaces·docker.io
油泼辣子多加5 小时前
2024年12月31日Github流行趋势
github
梓羽玩Python10 小时前
超酷的AI应用开发神器!1月内新增了5K Star!AI时代下开发者的“瑞士军刀”。
人工智能·github
油泼辣子多加1 天前
2024年12月30日Github流行趋势
github
华纳云IDC服务商1 天前
什么是递归解析服务器?它有什么特点
运维·服务器·github
小龙1 天前
本地创建了一个 Git 仓库推送到GitHub中
git·github·远程连接·团队协作
北城笑笑1 天前
GitLab 服务变更提醒:中国大陆、澳门和香港用户停止提供服务(GitLab 服务停止)
gitee·gitlab·github
王伯爵1 天前
git设置项目远程仓库指向github的一个仓库
git·github
编程洪同学1 天前
Jenkins 中自动化部署 Spring Boot 项目
java·spring boot·gitee·自动化·github·jenkins