deploy-kit zum Gitea-Template-Repo umbauen

Statt eines zweiten Repos wird deploy-kit selbst die Vorlage. Ein Template
kopiert das gesamte Repo, die Projektdateien muessen also im Wurzel-
verzeichnis liegen - template/ ist entsprechend aufgeloest.

- bootstrap.sh entfaellt: das Template uebernimmt seine Aufgabe, und
  Gitea kopiert serverseitig, funktioniert also auch bei privatem Repo.
- .gitea/template laesst Gitea ${REPO_NAME} in README.md und
  docker-compose.yml ersetzen. Projektname, Image und container_name
  stimmen damit ohne Handarbeit, offen bleibt nur der Port.
- CLAUDE.md zeigt auf DEPLOY.md, damit die Konventionen beim Arbeiten am
  erzeugten Projekt gelesen werden.
- DEPLOY.md liegt jetzt nur noch einmal - die Kopie im geplanten zweiten
  Repo waere unweigerlich auseinandergelaufen.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
2026-08-20 19:29:31 +02:00
parent 5b7418138e
commit f5bdb9a988
9 changed files with 70 additions and 111 deletions

View File

@@ -1,61 +1,55 @@
# deploy-kit
# ${REPO_NAME}
Vorlagen und Konventionen fuer Apps, die auf dem VPS per Tag-Push deployt
werden. Der Runner selbst liegt in
[gitea-runner](https://gitea.lucas-orth.de/lucas.orth/gitea-runner).
Aus der Vorlage
[deploy-kit](https://gitea.lucas-orth.de/lucas.orth/deploy-kit) erzeugt.
## In ein neues Projekt holen
## Einrichten
**1. Port setzen.** Den App-Namen hat Gitea beim Anlegen aus dem
Repo-Namen eingesetzt. Offen ist nur noch der Port:
```bash
curl -fsSL https://gitea.lucas-orth.de/lucas.orth/deploy-kit/raw/branch/main/bootstrap.sh | sh -s -- <app-name> <port>
sed -i "s/__PORT__/3000/g" docker-compose.yml Dockerfile
```
Oder erst herunterladen und ansehen, dann ausfuehren:
Auf den Port anpassen, auf dem die App tatsaechlich lauscht.
**2. Dockerfile anpassen.** Die Vorlage ist fuer Node mit TypeScript-Build.
**3. Build- und Test-Schritte** in `.gitea/workflows/deploy.yml`
einkommentieren.
**4. Healthcheck** in `docker-compose.yml` auf einen echten Endpoint zeigen
lassen. Er ist das Gate des Deploy-Schritts - zeigt er ins Leere, schlaegt
jeder Deploy fehl.
**5. Secret `DOTENV`** anlegen: Einstellungen -> Actions -> Secrets, mit dem
kompletten `.env`-Inhalt, mehrzeilig.
**6. Proxy Host** im Nginx Proxy Manager:
`${REPO_NAME}.lucas-orth.de` -> `${REPO_NAME}` : Port aus Schritt 1.
**7. Deployen:**
```bash
curl -fsSLO https://gitea.lucas-orth.de/lucas.orth/deploy-kit/raw/branch/main/bootstrap.sh && sh bootstrap.sh <app-name> <port>
git tag v1.0.0 && git push origin v1.0.0
```
Das Skript legt an, was fehlt, und laesst Vorhandenes unangetastet:
| Datei | Zweck |
|---|---|
| `DEPLOY.md` | Die Konventionen. Fuer dich und fuer Claude. |
| `docker-compose.yml` | Projektname, Image-Tag, Web-Netz, Healthcheck |
| `.gitea/workflows/deploy.yml` | Tag `v*` -> Build -> Test -> Deploy |
| `.dockerignore` | |
| `Dockerfile` | Node-Vorlage, pro Projekt anzupassen |
`__APP__` und `__PORT__` werden dabei ersetzt.
## Bestehende App umstellen
Fuer Apps, die heute per SCP deployt werden, gibt es eine eigene Anleitung -
inklusive Volume-Migration, damit der Wechsel des Projektnamens keine Daten
kostet:
## Pruefen, bevor der erste Tag faellt
```bash
curl -fsSL -o MIGRATION.md https://gitea.lucas-orth.de/lucas.orth/deploy-kit/raw/branch/main/MIGRATION.md
grep -n '__APP__\|__PORT__\|\${REPO_NAME}' docker-compose.yml Dockerfile
```
Dann Claude bitten, die Schritte darin auf das Projekt anzuwenden.
Kein Treffer heisst: alles ersetzt.
## Nur die Konventionen
Falls in `docker-compose.yml` `${IMAGE_TAG:-latest}` verstuemmelt ist, hat
die Template-Ersetzung zu viel angefasst - dann `docker-compose.yml` aus
`.gitea/template` streichen und die Platzhalter von Hand setzen.
Wenn ein Projekt schon eingerichtet ist und du nur die aktuelle Fassung der
Regeln brauchst:
## Konventionen
```bash
curl -fsSL -o DEPLOY.md https://gitea.lucas-orth.de/lucas.orth/deploy-kit/raw/branch/main/DEPLOY.md
```
**DEPLOY.md** - verbindlich, liegt im Projekt.
## Sichtbarkeit
Das Repo muss oeffentlich sein, damit `curl` ohne Umstaende funktioniert.
Es enthaelt keine Secrets - aber es beschreibt die Infrastruktur
(Domains, Netznamen, Containernamen). Wenn dir das zu viel ist, stell es auf
privat und setze beim Bootstrap ein Token:
```bash
DEPLOY_KIT_TOKEN=<gitea-pat-mit-read-scope> sh bootstrap.sh <app-name> <port>
```
**MIGRATION.md** gilt nur, wenn diese App vorher schon manuell auf dem
Server lief. Bei einem neuen Projekt kann die Datei geloescht werden.