diff --git a/README.md b/README.md index 3434d18623707b1109be73bc65be398966208e66..e7f7c0e72a40618c894cc2e9f996e949cd5cde3d 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 64dc7c286a6a66ff31ec5e573c54c664d0d76fc4..4d20c2de73a72fbbdc4af2f9119bb73b911c257f 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 5f92ba8581b745d4d74a53f80bea4b618f91ce66..0000000000000000000000000000000000000000 --- 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