From 991b780cb4f032f0fb53a44642f5d03c9dd2d7cd Mon Sep 17 00:00:00 2001
From: Sebastian <sebastian.karius@informatik.uni-halle.de>
Date: Mon, 30 Sep 2024 13:36:41 +0200
Subject: [PATCH] refactor

---
 README.md                                     | 41 ++++++++++++++++++-
 .../template.yml => docker-compose.yml        |  8 ++--
 templates/docker-compose/README.md            | 14 -------
 3 files changed, 45 insertions(+), 18 deletions(-)
 rename templates/docker-compose/template.yml => docker-compose.yml (93%)
 delete mode 100644 templates/docker-compose/README.md

diff --git a/README.md b/README.md
index 3434d18..e7f7c0e 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,42 @@
 # CI/CD Templates
 
-Repository für Gitlab CI/CD Templates
\ No newline at end of file
+Repository für Gitlab CI/CD Templates
+
+[TOC]
+
+## Components
+### docker-compose
+Baut und pusht eine vorhandene `docker-compose.yml`.
+
+* Testet, ob eine `docker-compose.yml` vorhanden ist
+* Container-Tags
+  * Für den Branch 'main' wird der Tag 'latest' gestzt
+  * Für jeden anderen Branch wird der Name des Branches als Tag gesetzt
+  * Für einen Git-Tag wird der Name des Git-Tag als Tag gesetzt
+
+Setzt die Umgebungsvariablen:
+* DOCKER_REGISTRY - Name der Docker Container Registry inklusive des Subpfades für den Projektordner
+* DOCKER_IMAGE_TAG - Container-Tag
+
+#### Beispiel
+Im Repository sollten diese Dateien angelegt werden.
+
+```yaml
+# docker-compose.yml
+
+services:
+  app:
+    image: ${DOCKER_REGISTRY}/app:${DOCKER_IMAGE_TAG}
+    build:
+      dockerfile: Dockerfile
+      context: .
+```
+
+```dotenv
+# .env
+
+# Docker compose build environment
+DOCKER_REGISTRY='mcr.informatik.uni-halle.de/abcde/repostory'
+DOCKER_IMAGE_TAG='latest'
+
+```
diff --git a/templates/docker-compose/template.yml b/docker-compose.yml
similarity index 93%
rename from templates/docker-compose/template.yml
rename to docker-compose.yml
index 64dc7c2..4d20c2d 100644
--- a/templates/docker-compose/template.yml
+++ b/docker-compose.yml
@@ -1,7 +1,9 @@
 spec:
   inputs:
-    stage:
+    job-stage:
       default: build
+    job-name:
+      default: docker-compose-build
     build_main:
       type: boolean
       default: true
@@ -16,10 +18,10 @@ spec:
       description: "Build a container with the git tag name as container tag."
 
 ---
-docker-compose-build:
+"$[[ inputs.job-name ]]":
     # Use the official docker image.
     image: docker:27
-    stage: $[[ inputs.stage ]]
+    stage: $[[ inputs.job-stage ]]
     services:
       - name: docker:27-dind
         alias: docker
diff --git a/templates/docker-compose/README.md b/templates/docker-compose/README.md
deleted file mode 100644
index 5f92ba8..0000000
--- a/templates/docker-compose/README.md
+++ /dev/null
@@ -1,14 +0,0 @@
-# docker-compose-build
-Baut und pusht eine vorhandene `docker-compose.yml`.
-
-* Testet ob eine `docker-compose.yml` vorhanden ist
-* Container-Tags
-  * Für den Branch 'main' wird der Tag 'latest' gestzt
-  * Für jeden anderen Branch wird der Name des Branches als Tag gesetzt
-  * Für einen Git-Tag wird der Name des Git-Tag als Tag gesetzt
-
-Setzt die Umgebungsvariablen:
-* DOCKER_REGISTRY - Name der Docker Container Registry inklusive des Subpfades für den Projektordner
-* DOCKER_IMAGE_TAG - Container-Tag
-
-## Beispiel
-- 
GitLab