add comments for gitlabci file

.gitlab-ci.yml

@@ -27,36 +27,18 @@ test:
   script:
     - make check
 
+# build new varnish image if dockerfile changes
 build:varnish:
   extends: .build-varnish
   rules:
     - changes:
       - container/Dockerfile.varnish
 
+# varnish image can be build when user triggers it
 build:varnish:manual:
   extends: .build-varnish
   when: manual
 
-.build-varnish:
-  stage: build
-  image: docker:19.03.8
-    - when: manual
-  services:
-    - docker:19.03.8-dind
-  variables:
-    IMAGE: varnish
-  before_script:
-   - apk add -U make
-   - docker login -u "$CI_REGISTRY_USER" -p "$CI_REGISTRY_PASSWORD" $CI_REGISTRY
-  script:
-    - docker pull $CI_REGISTRY/timleers/k8s-ingress/varnish-ingress/varnish-ingress/$IMAGE:latest || true
-    - cd container
-    - make varnish
-    - docker tag varnish-ingress/$IMAGE $CI_REGISTRY/timleers/k8s-ingress/varnish-ingress/$IMAGE:$CI_COMMIT_SHA
-    - docker tag varnish-ingress/$IMAGE $CI_REGISTRY/timleers/k8s-ingress/varnish-ingress/$IMAGE:latest
-    - docker push $CI_REGISTRY/timleers/k8s-ingress/varnish-ingress/$IMAGE:$CI_COMMIT_SHA
-    - docker push $CI_REGISTRY/timleers/k8s-ingress/varnish-ingress/$IMAGE:latest
-
 build:controller:
   stage: build
   image: docker:19.03.8
@@ -109,3 +91,23 @@ integration:
     - kind load docker-image varnish-ingress/varnish
     - kind load docker-image varnish-ingress/controller
     - test/e2e.sh
+
+# basic step for a pipeline to build the varnish image
+.build-varnish:
+  stage: build
+  image: docker:19.03.8
+  services:
+    - docker:19.03.8-dind
+  variables:
+    IMAGE: varnish
+  before_script:
+   - apk add -U make
+   - docker login -u "$CI_REGISTRY_USER" -p "$CI_REGISTRY_PASSWORD" $CI_REGISTRY
+  script:
+    - docker pull $CI_REGISTRY/timleers/k8s-ingress/varnish-ingress/varnish-ingress/$IMAGE:latest || true
+    - cd container
+    - make varnish
+    - docker tag varnish-ingress/$IMAGE $CI_REGISTRY/timleers/k8s-ingress/varnish-ingress/$IMAGE:$CI_COMMIT_SHA
+    - docker tag varnish-ingress/$IMAGE $CI_REGISTRY/timleers/k8s-ingress/varnish-ingress/$IMAGE:latest
+    - docker push $CI_REGISTRY/timleers/k8s-ingress/varnish-ingress/$IMAGE:$CI_COMMIT_SHA
+    - docker push $CI_REGISTRY/timleers/k8s-ingress/varnish-ingress/$IMAGE:latest