1
0
Fork 0
1Panel-Appstore/apps/action-runner/README.md

2.1 KiB
Raw Permalink Blame History

产品介绍

运行在容器中的简单的自托管 GitHub Actions 运行器

功能

  • 支持 Docker-out-of-Docker

  • 内置 github-cli python pip yq

配置和使用说明

参数 是否必须 说明
ROLE 必须 用于区分企业、组织与个人仓库
企业为 enterprises 组织为 orgs ,个人仓库为 repos
REST API
REPO 必须 企业格式为enterpriseName
组织格式为orgName
个人仓库格式为 owner/repo
REST API
RUNNER_GITHUB_TOKEN 必须 推荐 Fine-grained PAT
对于企业:
Fine-grained PAT 不能用于企业
OAuth 应用令牌和PATclassic需要 manage_runners:enterprise 权限。
对于组织:
应具备 Self-hosted runners 的读写权限。
OAuth 令牌和PATclassic需要 admin:org 权限,
此外私有组织仓库还需要 repo 权限。
对于个人仓库:
应具备 Administration 的读写权限。
OAuth 令牌和PATclassic需要 repo 权限。
如何创建令牌?
REST API
RUNNER_NAME Runner 名称,留空随机生成。
在同一个个人仓库(或企业、组织)中 Runner 名称不能重复。
RUNNER_LABELS Runner 标签,填写此项会增加新的标签,
若填入多个标签则用半角逗号分隔。
示例: label1,label2
WORK_FOLDER 工作文件夹,留空随机生成,几乎用不上。
RUNNER_GROUP Runner 组,默认值为Default,具体参见文档
AUTO_UNREGISTER 是否在容器停止时从 github.com 注销 Runner默认为 false

关于标注了REST API的问题,参考文档