@ cypress/ github- 承诺- status- 检查

基于 GH 应用安装设置 GitHub 承诺状态的小工具

此用途被GitHub App设备使用. 因此,您的环境应该有以下3个认证信息作为环境变量:

• GH_APP_ID
• GH_INSTALLATION_ID
• GH_PRIVATE_KEY

这个 GH_PRIVATE_KEY 是基础64编码的私钥。 例如,如果将私人"pem"文件的内容复制到剪贴板中,可以从终端执行"pbpaste QQ Base64 QQ pbcopy",并在剪贴板中得到编码字符串.

跟往常一样,我建议在当地使用 作为-a 函数.

使用

主要通过模块 API 使用,参见 标准/指数.ts

设置承诺检查

import { setCommitStatus } from '@cypress/github-commit-status-check'
await setCommitStatus({
  // bunch of options
})

有本脚本 src/bin/ set-承诺-状态.ts 从命令行参数读取选项。 例如,如果环境变量被存储在块中 set-status 在你身边 作为-a 设置,然后:

$ as-a set-status npm run set-commit-status -- --repo ...

添加对犯罪的评论

$ as-a set-status npm run add-commit-comment -- --repo ...

调试

以环境变量运行 DEBUG=@cypress/github-commit-status-check 查看更多日志消息