From 9d433f6b43fdee97ed365f827238c28cbd495a6a Mon Sep 17 00:00:00 2001 From: Snider Date: Fri, 20 Feb 2026 15:11:26 +0000 Subject: [PATCH] docs: add README with quick start and docs links Co-Authored-By: Virgil --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..17ba311 --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# go-devops + +Infrastructure and build automation library for the Lethean ecosystem. Provides a native Go Ansible playbook executor (~30 modules over SSH without shelling out), a multi-target build pipeline with project type auto-detection (Go, Wails, Docker, C++, LinuxKit, Taskfile), code signing (macOS codesign, GPG, Windows signtool), release orchestration with changelog generation and eight publisher backends (GitHub Releases, Docker, Homebrew, npm, AUR, Scoop, Chocolatey, LinuxKit), Hetzner Cloud and Robot API clients, CloudNS DNS management, container/VM management via QEMU and Hyperkit, an OpenAPI SDK generator (TypeScript, Python, Go, PHP), and a developer toolkit with cyclomatic complexity analysis, vulnerability scanning, and coverage trending. + +**Module**: `forge.lthn.ai/core/go-devops` +**Licence**: EUPL-1.2 +**Language**: Go 1.25 + +## Quick Start + +```go +import ( + "forge.lthn.ai/core/go-devops/ansible" + "forge.lthn.ai/core/go-devops/build" + "forge.lthn.ai/core/go-devops/release" +) + +// Run an Ansible playbook over SSH +pb, _ := ansible.ParsePlaybook("playbooks/deploy.yml") +inv, _ := ansible.ParseInventory("inventory.yml") +pb.Run(ctx, inv) + +// Build and release +artifacts, _ := build.Build(ctx, ".") +release.Publish(ctx, releaseCfg, false) +``` + +## Documentation + +- [Architecture](docs/architecture.md) — Ansible integration, build pipeline, infrastructure APIs, release workflow, devkit, SDK generation +- [Development Guide](docs/development.md) — building, testing, coding standards +- [Project History](docs/history.md) — completed phases and known limitations + +## Build & Test + +```bash +go test ./... +go test -race ./... +go vet ./... +go build ./... +``` + +## Licence + +European Union Public Licence 1.2 — see [LICENCE](LICENCE) for details.