actions-template/README.md

58 lines
1.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 🎯 Gitea Runner Template
[![Docker](https://img.shields.io/badge/docker-ready-brightgreen.svg)](https://www.docker.com/)
> Gitea Runner Docker 部署模板,附带可直接复用的 Actions workflow 示例。
## 📖 这个仓库提供什么
- `docker-runner/presets/`:可直接部署的 runner 预设
- `docker-runner/common/`:安装、注册、升级、管理脚本
- `.gitea/workflows/`:可复制的 workflow 示例
- `.gitea/ci/bootstrap_workspace.sh`workflow 工作区自举脚本
## ⚙️ 当前默认行为
- 新注册的 runner 默认 `capacity=4`
- 大仓库会缓存到 `/data/git-mirrors/<owner>/<repo>.git`
- 每个 workflow job 使用独立临时目录 `/home/workspace/jobs/<owner>/<repo>/<job-identity>/repo`
- job 结束后自动清理临时工作目录mirror 缓存保留在 `runner-data/`
- 每个 preset 通过 `.env.example` 提供实例配置模板,部署时复制为 `.env`
## 🚀 快速开始
以标准 Ubuntu 22.04 预设为例:
```bash
cd docker-runner/presets/standard-ubuntu-22
cp .env.example .env
docker compose build
docker compose up -d
docker compose exec gitea-runner /data/setup.sh
docker compose exec gitea-runner /data/register.sh
```
开始前至少需要在 `.env` 中填好 `GITEA_TOKEN`,必要时调整 `GITEA_INSTANCE`
完整部署步骤、Buildx 版本选择、升级和故障排查见 [DEPLOYMENT.md](./DEPLOYMENT.md)。
## 📂 你要找什么
- 部署或运维 runner看 [DEPLOYMENT.md](./DEPLOYMENT.md)
- 使用或定制 workflow看 [WORKFLOW.md](./WORKFLOW.md)
- 查看当前示例 workflow直接看 `.gitea/workflows/`
## 🗂️ 仓库结构
```txt
.
├── .gitea/
│ ├── ci/bootstrap_workspace.sh
│ └── workflows/
├── docker-runner/
│ ├── common/
│ └── presets/
├── DEPLOYMENT.md
└── WORKFLOW.md
```