diff --git a/apps/action-runner/README.md b/apps/action-runner/README.md index 98f20f814..750fb21c6 100644 --- a/apps/action-runner/README.md +++ b/apps/action-runner/README.md @@ -1,6 +1,4 @@ -# Github Action Runner - -![](https://fastly.jsdelivr.net/gh/actions/runner@main/docs/res/github-graph.png) +## 产品介绍 运行在容器中的简单的自托管 GitHub Actions 运行器 @@ -8,7 +6,10 @@ - 支持 Docker-out-of-Docker -### 环境变量 +- 内置 [github-cli](https://github.com/cli/cli) python pip [yq](https://github.com/mikefarah/yq) + +## 配置和使用说明 + | 参数 | 是否必须 | 说明 | | --- | --- | --- | | `ROLE` | 必须 | 用于区分企业、组织与个人仓库
企业为 `enterprises` 组织为 `orgs` ,个人仓库为 `repos`
**REST API** | diff --git a/apps/action-runner/README_en.md b/apps/action-runner/README_en.md index cc3b7bcfd..7926605bd 100644 --- a/apps/action-runner/README_en.md +++ b/apps/action-runner/README_en.md @@ -1,6 +1,4 @@ -# Simple Github Action Runner In Docker - -![](http://fastly.jsdelivr.net/gh/actions/runner@main/docs/res/github-graph.png) +## Introduction A simple self-hosted actions runner running in a container @@ -8,7 +6,10 @@ A simple self-hosted actions runner running in a container - Supports Docker-out-of-Docker -### Environment Variables +- Built-in [github-cli](https://github.com/cli/cli) python pip [yq](https://github.com/mikefarah/yq) + +## Configuration and Usage Instructions + | Parameter | Required | Description | | --- | --- | --- | | `ROLE` | Required | Used to differentiate between enterprise, organization, and personal repositories.
Use `enterprises` for enterprise, `orgs` for organization, and `repos` for personal repositories.
**REST API** |