Claude Fable 5
b16d23297e
pnpm workspace with apps/web, apps/api, apps/collab, and packages/shared; strict TypeScript base config, repo-wide ESLint (flat) + Prettier, Vitest per package, and root scripts lint/typecheck/test/ build. @dorfteich/shared ships a first health-response helper consumed by apps/api to prove workspace linking. Existing markdown docs are reformatted once by the new Prettier setup. Closes #1 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
59 lines
2.8 KiB
Markdown
59 lines
2.8 KiB
Markdown
# ADR 0014: CI/CD with Gitea Actions, staged promotion
|
|
|
|
- Status: accepted
|
|
- Date: 2026-07-04
|
|
|
|
## Context
|
|
|
|
The project is hosted on a self-managed Gitea (`gitea.101010.cloud`).
|
|
Environments (kickoff): Dev runs locally on contributors' machines;
|
|
Test and Int run as separate Compose stacks on the operator's VPS
|
|
(`188.245.116.44`, domains `test.dorfteich.cloud` / `int.dorfteich.cloud`);
|
|
the Prod host (`dorfteich.online`) is decided at go-live — the VPS or a
|
|
dedicated host — so the architecture must keep that choice and any later
|
|
move cheap. Contributors include AI coding sessions — gates must be
|
|
automated and objective wherever possible.
|
|
|
|
## Decision
|
|
|
|
- **Gitea Actions** is the CI/CD system (GitHub-Actions-compatible syntax);
|
|
an act_runner runs on the VPS (`188.245.116.44`) with Docker access.
|
|
- **Images** are built once per change and promoted, never rebuilt per
|
|
stage: pushed to the **Gitea container registry**
|
|
(`gitea.101010.cloud/stwaidele/dorfteich-{web,api,collab}`), tagged with
|
|
the git SHA plus moving tags `test`, `int`, and semver tags for releases.
|
|
- **Pipeline** (details in `deployment.md`):
|
|
1. **PR / push**: lint, typecheck, unit tests, build; PRs must be green to
|
|
merge into `main`.
|
|
2. **Merge to `main`**: build + push images (SHA tag) → deploy to
|
|
**Test** automatically → run the Playwright e2e suite against Test.
|
|
3. **Promotion to Int**: automatic when e2e on Test is green — Int is the
|
|
stable preview environment (same images, `int` tag).
|
|
4. **Promotion to Prod**: **manual gate** — creating a release tag
|
|
(`vX.Y.Z`) triggers the Prod deploy after a required manual approval
|
|
in the workflow. Database migrations run automatically on container
|
|
start (ADR 0006); releases with breaking migrations must say so in the
|
|
release notes.
|
|
- **Deploy mechanism**: the runner executes `docker compose pull && docker
|
|
compose up -d` in the stage's directory (`/home/DOCKER/dorfteich-<stage>/`)
|
|
over SSH (deploy key per stage). Moving Prod to a dedicated host later
|
|
changes only that SSH target.
|
|
- **Self-hosters** consume the same release images via a published
|
|
`docker-compose.yml` pinned to semver tags (update strategy in
|
|
`operations.md`).
|
|
|
|
## Consequences
|
|
|
|
- One objective quality bar (green e2e on Test) decides Int promotion; the
|
|
only human gate is the Prod release — matching the risk profile.
|
|
- The registry, runner, and repo live on the same Gitea — no third-party CI
|
|
dependency.
|
|
- e2e stability becomes load-bearing; flaky tests block the pipeline and
|
|
must be treated as defects (stated in the contributor conventions).
|
|
|
|
## Alternatives considered
|
|
|
|
- **GitHub Actions with repo mirror**: splits source of truth; rejected.
|
|
- **Manual deploys per stage**: does not scale to many small stories and
|
|
invites drift between stages.
|