Emil SimeonovandDevin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
749b4d025f
shields.io can't fetch JSON from our self-hosted Gitea instance (not publicly reachable), so badges showed "unknown". Switched to generating self-contained SVG badge files that are served directly by Gitea's raw file API — no external service needed. Changes: - generate_badges.py: Added render_svg() to produce shields.io-style SVG badges with gradient, rounded corners, and Verdana font - Replaced xml.sax.saxutils.escape with a simple _xml_escape() to avoid bandit B406 warning (no defusedxml dependency needed) - CI workflow: Push .svg files instead of .json to badges branch - README.md and docs/index.md: Updated badge URLs to use raw SVG from the badges branch instead of shields.io endpoint Also fixed: - Coverage regex now handles 100% without decimal (was 100.00%) - doc_coverage.py: Removed redundant % in pct variable that caused double-percent (100%%) in output Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
36 lines
2.5 KiB
Markdown
36 lines
2.5 KiB
Markdown
# GRM — Gitea Runner Manager
|
|
|
|
A lean command-line tool to automate the installation, configuration, and lifecycle management of Gitea Actions runners on Arch Linux, Ubuntu, and Debian hosts.
|
|
|
|
> **Pronunciation:** GRM is short for *Gitea Runner Manager*, but say it like **ГРЪМ** (roughly "GRUM") — the Bulgarian word for **thunder**. An open-source project from **Oblachno** (облачно means *cloudy* in Bulgarian).
|
|
|
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/grm/actions)
|
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/grm/actions)
|
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/grm/actions)
|
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/grm/wiki)
|
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/grm/actions)
|
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/grm/releases)
|
|
|
|
## User Documentation
|
|
|
|
- [Getting Started](Getting-Started.-) — Installation, quick start, first run
|
|
- [Installation](Installation) — Prerequisites, setup, multiple instances
|
|
- [CLI Commands](CLI-Commands.-) — All commands with arguments and options
|
|
- [Troubleshooting](Troubleshooting) — Common issues and solutions
|
|
- [FAQ](FAQ) — Frequently asked questions
|
|
|
|
## Technical Documentation
|
|
|
|
- [Architecture](Architecture) — High-level design, component interactions, data flow
|
|
- [Development Setup](Development-Setup.-) — Environment setup, dependencies, local testing
|
|
- [CI/CD Workflow](CI-CD-Workflow.-) — How CI works, release process, branch protection
|
|
- [Testing Strategy](Testing-Strategy.-) — Unit, integration, and Molecule tests
|
|
- [Decision Log](Decision-Log.-) — Key technical decisions and rationale
|
|
- [Contributing Guide](Contributing-Guide.-) — Coding standards, PR workflow, commit rules
|
|
|
|
## Quick Links
|
|
|
|
- [Repository](https://git.oblachno.oblachno.fyi/oblachno-oss/grm)
|
|
- [CI/CD Pipeline](https://git.oblachno.oblachno.fyi/oblachno-oss/grm/actions)
|
|
- [Changelog](https://git.oblachno.oblachno.fyi/oblachno-oss/grm/src/branch/master/CHANGELOG.md)
|