actions-template/README.md

63 lines
1.5 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 示例 + 文档规范
## 📖 项目简介
这是一个完整的 Gitea Runner 模板项目,提供:
- 🐳 **Docker 部署方案**:开箱即用的 Runner 容器化部署
- 📝 **Workflow 示例**:自动化 CHANGELOG 和 Release 工作流
- 📚 **文档规范**:统一的文档格式和版本管理规范
- 🔧 **配置指南**:详细的配置说明和最佳实践
## 📂 文档导航
### 🚀 Runner
#### [DEPLOYMENT.md](./DEPLOYMENT.md)
**Gitea Runner Docker 部署完整教程**
包含内容:
- 📦 标准版 vs Buildx 多架构版选择
- 📝 Dockerfile 和 docker-compose.yml 配置
- 🔧 安装、注册、管理脚本详解
- ⚙️ 完整的部署流程
- ❓ 常见问题和故障排除
👉 **完整的 Runner 部署教程,从零开始搭建**
---
### 📋 [Workflow](./WORKFLOW.md)
**Gitea Actions 自动化工作流示例**
包含内容:
- 💡 工作流配置说明
- 🔧 如何使用和定制
- 🔄 案例:`changelog_and_release.yml` - 自动更新 CHANGELOG 和自动创建 Release
👉 **实用的 Actions 工作流,可直接复制使用**
---
### 📝 [Conventions](./CONVENTIONS.md)
**文档编写规范和版本命名规则**
包含内容:
- 📊 Emoji 图标使用规范
- 🔢 版本号命名规则SemVer
- 📝 [CHANGELOG](./CHANGELOG.md) 模板
👉 **维护项目文档的统一规范,贡献者必读**
---