Merge pull request #3801 from xmudrii/comment-deps

Add clarification comments to `dependencies.yaml`

dependencies.yaml

@@ -20,7 +20,10 @@ dependencies:
     - path: images/build/go-runner/cloudbuild.yaml
       match: ghcr.io/sigstore/cosign/cosign:v(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?-dev@sha256:[a-f0-9]{64}
 
+  # Go versions
+
   # Golang (for images, latest)
+  # To be updated before kubernetes/kubernetes update
   - name: "golang (latest)"
     version: 1.23.2
     refPaths:
@@ -35,7 +38,8 @@ dependencies:
     - path: images/releng/ci/variants.yaml
       match: "GO_VERSION: '\\d+.\\d+(alpha|beta|rc)?\\.?(\\d+)?'"
 
-  # Golang (for images, previous)
+  # Golang (for images, previous stable)
+  # To be updated before kubernetes/kubernetes update
   - name: "golang (previous)"
     version: 1.22.8
     refPaths:
@@ -83,12 +87,7 @@ dependencies:
     - path: images/build/go-runner/go.mod
       match: go \d+.\d+
 
-  - name: "go-runner"
-    version: v2.3.1
-    refPaths:
-    - path: images/build/go-runner/VERSION
-
-  # Golang images
+  # Build and user images
 
   # Represents the targeted Kubernetes version at the time the images
   # are to be created e.g., 'v1.100.0'
@@ -121,21 +120,28 @@ dependencies:
     - path: images/releng/ci/variants.yaml
       match: REVISION:\ '\d+'
 
-  # releng-ci (next candidate, to be used when changing revision)
+  # releng-ci (next candidate)
   - name: "gcr.io/k8s-staging-releng/releng-ci: image revision (next candidate)"
     version: 0
     refPaths:
     - path: images/releng/ci/variants.yaml
       match: REVISION:\ '\d+'
 
-  # releng-ci (for previous release branches)
-  - name: "gcr.io/k8s-staging-releng/releng-ci: image revision (for previous release branches)"
+  # releng-ci (previous release branches)
+  - name: "gcr.io/k8s-staging-releng/releng-ci: image revision (previous release branches)"
     version: 0
     refPaths:
     - path: images/releng/ci/variants.yaml
       match: REVISION:\ '\d+'
 
   # go-runner
+  - name: "go-runner"
+    version: v2.3.1
+    refPaths:
+    - path: images/build/go-runner/VERSION
+
+  # go-runner (latest Golang)
+  # To be updated before kubernetes/kubernetes update
   - name: "registry.k8s.io/build-image/go-runner (go1.23-bookworm)"
     version: v2.3.1-go1.23.2-bookworm.0
     refPaths:
@@ -150,6 +156,8 @@ dependencies:
     - path: images/build/go-runner/variants.yaml
       match: REVISION:\ '\d+'
 
+  # go-runner (previous stable Golang)
+  # To be updated before kubernetes/kubernetes update
   - name: "registry.k8s.io/build-image/go-runner (go1.22-bookworm)"
     version: v2.3.1-go1.22.8-bookworm.0
     refPaths:
@@ -164,15 +172,15 @@ dependencies:
     - path: images/build/go-runner/variants.yaml
       match: REVISION:\ '\d+'
 
-  # kube-cross (to be updated before updating kubernetes/kubernetes)
-  # Next candidate
+  # kube-cross (next candidate)
   # - name: "registry.k8s.io/build-image/kube-cross: config variant (next candidate)"
   #   version: go1.24rc1-bullseye
   #   refPaths:
   #   - path: images/build/cross/variants.yaml
   #     match: "CONFIG: 'go\\d+.\\d+-bullseye'"
 
-  # Kubernetes v1.31
+  # kube-cross (Kubernetes v1.31)
+  # To be updated before kubernetes/kubernetes update
   - name: "registry.k8s.io/build-image/kube-cross (v1.31-go1.23)"
     version: v1.31.0-go1.23.2-bullseye.0
     refPaths:
@@ -193,7 +201,8 @@ dependencies:
     - path: images/build/cross/variants.yaml
       match: REVISION:\ '\d+'
 
-  # Kubernetes v1.31 (Go 1.22)
+  # kube-cross (Kubernetes v1.31, Go 1.22)
+  # To be updated before kubernetes/kubernetes update
   - name: "registry.k8s.io/build-image/kube-cross (v1.31-go1.22)"
     version: v1.31.0-go1.22.8-bullseye.0
     refPaths:
@@ -214,7 +223,8 @@ dependencies:
     - path: images/build/cross/variants.yaml
       match: REVISION:\ '\d+'
 
-  # Kubernetes v1.30
+  # kube-cross (Kubernetes v1.30)
+  # To be updated before kubernetes/kubernetes update
   - name: "registry.k8s.io/build-image/kube-cross (v1.30-go1.22)"
     version: v1.30.0-go1.22.8-bullseye.0
     refPaths:
@@ -235,7 +245,8 @@ dependencies:
     - path: images/build/cross/variants.yaml
       match: REVISION:\ '\d+'
 
-  # Kubernetes v1.29
+  # kube-cross (Kubernetes v1.29)
+  # To be updated before kubernetes/kubernetes update
   - name: "registry.k8s.io/build-image/kube-cross (v1.29-go1.22)"
     version: v1.29.0-go1.22.8-bullseye.0
     refPaths:
@@ -256,7 +267,8 @@ dependencies:
     - path: images/build/cross/variants.yaml
       match: REVISION:\ '\d+'
 
-  # Kubernetes v1.28
+  # kube-cross (Kubernetes v1.28)
+  # To be updated before kubernetes/kubernetes update
   - name: "registry.k8s.io/build-image/kube-cross (v1.28-go1.22)"
     version: v1.28.0-go1.22.8-bullseye.0
     refPaths:
@@ -277,7 +289,8 @@ dependencies:
     - path: images/build/cross/variants.yaml
       match: REVISION:\ '\d+'
 
-  # kube-cross (to be updated after updating kubernetes/kubernetes)
+  # kube-cross dependents (i.e. k8s-cloud-builder)
+  # To be updated after kubernetes/kubernetes update)
   - name: "registry.k8s.io/build-image/kube-cross: dependents k8s-cloud-builder (v1.32-cross1.23)"
     version: v1.32.0-go1.23.2-bullseye.0
     refPaths: