Document script flags and image verification behavior

2026-03-19 22:47:49 +01:00
parent afea257f86
commit 237be77014
1 changed files with 63 additions and 0 deletions
@@ -58,6 +58,69 @@ Scriptet läser `Apps/<app-id>/docker-compose.yaml` och bygger alla services som
 `--component` kan användas för en enskild service (service-namn eller context-path).
 Arkitekturer hämtas från `x-casaos.architectures`; builden kör fail-open per arkitektur och visar varningar i slutet för misslyckade arch-builds.

+## Scripts
+
+### `validate-appstore.sh`
+
+Basvalidering:
+
+```bash
+./scripts/validate-appstore.sh
+```
+
+Strikt riskdokumentationskontroll:
+
+```bash
+./scripts/validate-appstore.sh --enforce-risk-docs
+```
+
+### `build-and-push-image.sh`
+
+Bygger och pushar appens custom images till Docker Hub (`joafri` som default).
+
+```bash
+./scripts/build-and-push-image.sh --app-id caddy-autogen --tag 0.2.0
+```
+
+Viktiga flaggor:
+
+- `--component <value>`: bygg endast en service (service-namn eller context-path).
+- `--repo <namespace>`: byt namespace (default `joafri`).
+- `--no-push`: bygg utan push.
+
+Beteende:
+
+- Läser `Apps/<app-id>/docker-compose.yaml`.
+- Bygger alla services med `build:` om `--component` inte anges.
+- Läser arkitekturer från `x-casaos.architectures`.
+- Bygger per arkitektur och skapar manifest-tag.
+- Fail-open per arkitektur (varning i slutet om någon arch misslyckas).
+
+### `build-appstore-zip.sh`
+
+Bygger appstore-zip (inklusive `.yaml` -> `.yml` export i staging).
+
+```bash
+./scripts/build-appstore-zip.sh
+```
+
+Bygg och publicera `dist/` till `main`:
+
+```bash
+./scripts/build-appstore-zip.sh --push
+```
+
+Viktiga flaggor:
+
+- `--push`: byter till `main`, `git add dist/`, commit `Updated appstore`, push `origin main`.
+- `--strict-images`: fail-closed om någon image i apparna saknas online.
+
+Image-verifiering:
+
+- Scriptet verifierar alla `image:` i `Apps/*/docker-compose.yaml` (skippar `_template`) via registry-manifest.
+- Standardläge: fail-open (varningar skrivs ut, zip byggs ändå).
+- CI/Gitea-runner (`CI=true` eller `GITEA_ACTIONS=true`): scriptet blir automatiskt strikt och returnerar felkod om någon image saknas.
+
 ## Säkerhetsriktlinjer

 - Undvik privilegierad container, host network och `docker.sock` om det inte är absolut nödvändigt.