fix(updatecli): Added comments

gounthar · Sep 26, 2024 · 6f800cf · 6f800cf
1 parent c21b140
commit 6f800cf
Showing 1 changed file with 15 additions and 13 deletions.
diff --git a/updatecli/updatecli.d/rhel-ubi9.yaml b/updatecli/updatecli.d/rhel-ubi9.yaml
@@ -1,4 +1,6 @@
 ---
+# This YAML configuration file is used to bump the UBI9 version in the Dockerfile and docker-bake.hcl and create a pull request with the changes.
+
 name: Bump UBI9 version
 
 scms:
@@ -15,49 +17,49 @@ scms:
 
 sources:
   latestVersion:
-    name: "Get the latest UBI9 Linux version"
+    name: "Get the latest UBI9 Linux version" # Source to get the latest UBI9 version
     kind: shell
     spec:
-      command: bash updatecli/scripts/ubi9-latest-tag.sh
+      command: bash updatecli/scripts/ubi9-latest-tag.sh # Command to fetch the latest UBI9 tag
 
 conditions:
   checkUbi9DockerImage:
     kind: dockerimage
-    name: Check if the container image "ubi9" is available
+    name: Check if the container image "ubi9" is available # Condition to check if the UBI9 Docker image is available
     spec:
       architectures:
         - linux/amd64
         - linux/arm64
         - linux/s390x
         - linux/ppc64le
-      image: registry.access.redhat.com/ubi9
+      image: registry.access.redhat.com/ubi9 # Docker image to check. The tag is automatically set to the version found in the only source
 
 targets:
   updateDockerfile:
-    name: "Update the value of the base image (ARG UBI9_TAG) in the Dockerfile"
+    name: "Update the value of the base image (ARG UBI9_TAG) in the Dockerfile" # Target to update the Dockerfile with the new UBI9 tag
     kind: dockerfile
     sourceid: latestVersion
     spec:
-      file: rhel/ubi9/Dockerfile
+      file: rhel/ubi9/Dockerfile # Path to the Dockerfile
       instruction:
-        keyword: "ARG"
-        matcher: "UBI9_TAG"
+        keyword: "ARG" # Dockerfile instruction keyword
+        matcher: "UBI9_TAG" # Dockerfile instruction matcher
     scmid: default
   updateDockerBake:
-    name: "Update the default value of the variable UBI9_TAG in the docker-bake.hcl"
+    name: "Update the default value of the variable UBI9_TAG in the docker-bake.hcl" # Target to update the docker-bake.hcl file with the new UBI9 tag
     kind: hcl
     sourceid: latestVersion
     spec:
-      file: docker-bake.hcl
-      path: variable.UBI9_TAG.default
+      file: docker-bake.hcl # Path to the docker-bake.hcl file
+      path: variable.UBI9_TAG.default # Path to the variable in the HCL file
     scmid: default
 
 actions:
   default:
     kind: github/pullrequest
     scmid: default
-    title: Bump UBI9 version to {{ source "latestVersion" }}
+    title: Bump UBI9 version to {{ source "latestVersion" }} # Title of the pull request
     spec:
       labels:
         - dependencies
-        - rhel-ubi9
+        - rhel-ubi9 # Labels for the pull request