From e562d1fefd4f794111de1929ad5939f651ee451e Mon Sep 17 00:00:00 2001
From: Artur Zych <5843875+azych@users.noreply.github.com>
Date: Mon, 13 Jan 2025 09:40:00 +0100
Subject: [PATCH] chore: doc comment the need to keep using blang for version
 ranges

---
 internal/catalogmetadata/filter/successors.go | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/internal/catalogmetadata/filter/successors.go b/internal/catalogmetadata/filter/successors.go
index 67f24e97eb..13467614a4 100644
--- a/internal/catalogmetadata/filter/successors.go
+++ b/internal/catalogmetadata/filter/successors.go
@@ -60,6 +60,11 @@ func legacySuccessor(installedBundle ocv1.BundleMetadata, channels ...declcfg.Ch
 			}
 		}
 		if candidateBundleEntry.SkipRange != "" {
+			// There are differences between how "github.com/blang/semver/v4" and "github.com/Masterminds/semver/v3"
+			// handle version ranges. OLM v0 used blang and there might still be registry+v1 bundles that rely
+			// on those specific differences. Because OLM v1 supports registry+v1 bundles,
+			// blang needs to be kept alongside any other semver lib for range handling.
+			// see: https://github.com/operator-framework/operator-controller/pull/1565#issuecomment-2586455768
 			skipRange, err := bsemver.ParseRange(candidateBundleEntry.SkipRange)
 			if err == nil && skipRange(installedBundleVersion) {
 				return true