ci: drive pipeline via make targets + local make ci gate (refs #30)
Add a root Makefile (lint/build/unit/smoke/ci) as the single source of truth for the checks, and have each Gitea Actions job call the matching make target so local and CI cannot drift. `make ci` runs the full pipeline locally — the interim gate while no runner is registered. The smoke target auto-points DOCKER_HOST at the rootless Podman socket when present (and DOCKER_HOST is unset), leaving Docker/CI hosts alone. Document `make ci` and the Podman prerequisites in docs/runbooks/ci.md. Verified: `make ci` is green locally (lint, build, unit, container smoke). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
@@ -1,26 +1,54 @@
|
||||
# CI runbook — Gitea Actions
|
||||
|
||||
> **Status: pending runner.** The workflow `.gitea/workflows/ci.yaml` is in place,
|
||||
> but the pipeline cannot go green until a self-hosted runner with the
|
||||
> `respellion-linux` label is registered against the Gitea instance. Until then
|
||||
> runs stay queued. Tracked by issue **#30 (S-00-c)**, which stays open until CI
|
||||
> is verified green.
|
||||
> **Status: no runner yet → run CI locally with `make ci`.** The workflow
|
||||
> `.gitea/workflows/ci.yaml` is in place, but the pipeline cannot go green until a
|
||||
> self-hosted `respellion-linux` runner is registered against the Gitea instance.
|
||||
> Until then, **`make ci` is the gate** — it runs the exact same checks locally
|
||||
> (the workflow calls the same `make` targets). Issue **#30 (S-00-c)** stays open
|
||||
> until CI is verified green on a runner.
|
||||
|
||||
## The pipeline
|
||||
|
||||
`.gitea/workflows/ci.yaml` runs on every push and pull request to `main`. Jobs:
|
||||
`.gitea/workflows/ci.yaml` runs on every push and pull request to `main`. Each job
|
||||
calls a `make` target — the **single source of truth** for the checks, so local
|
||||
and CI cannot drift:
|
||||
|
||||
| Job | Command | Needs |
|
||||
| Job | Target | Needs |
|
||||
|---|---|---|
|
||||
| `lint` | `dotnet format services/bff/Bff.slnx --verify-no-changes` | .NET 10 SDK |
|
||||
| `build` | `dotnet build services/bff/Bff.slnx -c Release` | .NET 10 SDK |
|
||||
| `unit` | `dotnet test services/bff/Bff.slnx -c Release` | .NET 10 SDK |
|
||||
| `compose-smoke` | `docker compose -f infra/docker-compose.yml up -d --build --wait` → `curl /health` → `down` | container engine + compose v2 |
|
||||
| `lint` | `make lint` → `dotnet format … --verify-no-changes` | .NET 10 SDK |
|
||||
| `build` | `make build` → `dotnet build … -c Release` | .NET 10 SDK |
|
||||
| `unit` | `make unit` → `dotnet test … -c Release` | .NET 10 SDK |
|
||||
| `compose-smoke` | `make smoke` → compose up `--wait` → `curl /health` → `down` | container engine + compose v2 |
|
||||
|
||||
All `uses:` references are absolute, tag-pinned URLs (`https://github.com/actions/checkout@v4`,
|
||||
`https://github.com/actions/setup-dotnet@v4`) per CLAUDE.md §8.7 and §15 — Gitea
|
||||
Actions resolves them from GitHub.
|
||||
|
||||
## Running CI locally (`make ci`)
|
||||
|
||||
Until the runner exists, run the full pipeline yourself before pushing:
|
||||
|
||||
```bash
|
||||
make ci # lint + build + unit + smoke — what the pipeline runs
|
||||
make lint # or a single stage
|
||||
make smoke # compose up --wait, curl /health, tear down
|
||||
```
|
||||
|
||||
**Prerequisites:** .NET 10 SDK, a container engine with Compose v2, and `curl`.
|
||||
|
||||
On a **rootless Podman** box (the default dev setup here), the `smoke` target needs
|
||||
the Podman API socket and a Compose provider:
|
||||
|
||||
```bash
|
||||
systemctl --user enable --now podman.socket # start the API socket
|
||||
ln -sf "$(command -v podman)" ~/.local/bin/docker # docker -> podman shim
|
||||
# install Docker Compose v2 into ~/.local/bin as `docker-compose` (the provider)
|
||||
```
|
||||
|
||||
The Makefile auto-points `DOCKER_HOST` at `/run/user/$(id -u)/podman/podman.sock`
|
||||
when that socket exists and `DOCKER_HOST` is unset, so `make smoke` "just works"
|
||||
locally while leaving real Docker hosts / CI runners untouched.
|
||||
|
||||
## Runner: `respellion-linux`
|
||||
|
||||
The single self-hosted runner label this repo targets is **`respellion-linux`**
|
||||
|
||||
Reference in New Issue
Block a user