From 4b5ae81daeb0469b89e2bf20e7f87afa6096319c Mon Sep 17 00:00:00 2001
From: Simon <simon.priet@gmail.com>
Date: Mon, 8 May 2023 10:56:45 +0200
Subject: [PATCH] Made some documentation

---
 .gitlab/.gitlab-ci.yml | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/.gitlab/.gitlab-ci.yml b/.gitlab/.gitlab-ci.yml
index be738cf..48166dc 100644
--- a/.gitlab/.gitlab-ci.yml
+++ b/.gitlab/.gitlab-ci.yml
@@ -10,11 +10,13 @@ variables:
   RELEASE_VERSION: v0.$CI_PIPELINE_IID
   PACKAGE_REGISTRY_URL: "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/generic/${PACKAGE_NAME}/${RELEASE_VERSION}"
 
+# Jobs from here run on Merge Requests as prerequisite for merging.
 .gen-manifest-job: &gen-manifest
   stage: Manifest
   rules:
     - if: $CI_PIPELINE_SOURCE == "merge_request_event"
       changes:
+        # TODO: refacto this (as Reference or something else)
         - ${ENTRY_FOLDER}/${PACKAGE_NAME}/*
   script:
     - echo testing ${PACKAGE_NAME}.md
@@ -38,6 +40,7 @@ check-content-job/valid_set:
     PACKAGE_NAME: "valid_set"
   <<: *check-content
 
+# Jobs from here run Merged_results or Push/Merge Commits to the main branch. Tag is created on release so no run with tag creation
 .bundle-job: &bundle
   stage: Bundle
   image: javieraviles/zip:latest