chore: doc comment the need to keep using blang for version ranges (#1600)

azych · web-flow · commit 96972f0858ab · 2025-01-17T18:42:28.000Z
Co-authored-by: Artur Zych &lt;5843875+azych@users.noreply.github.com&gt;
diff --git 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

Original file line number	Diff line number	Diff line change
`@@ -60,6 +60,11 @@ func legacySuccessor(installedBundle ocv1.BundleMetadata, channels ...declcfg.Ch`
`60`	`60`	`}`
`61`	`61`	`}`
`62`	`62`	`if candidateBundleEntry.SkipRange != "" {`
	`63`	`+ // There are differences between how "github.com/blang/semver/v4" and "github.com/Masterminds/semver/v3"`
	`64`	`+ // handle version ranges. OLM v0 used blang and there might still be registry+v1 bundles that rely`
	`65`	`+ // on those specific differences. Because OLM v1 supports registry+v1 bundles,`
	`66`	`+ // blang needs to be kept alongside any other semver lib for range handling.`
	`67`	`+ // see: https://github.com/operator-framework/operator-controller/pull/1565#issuecomment-2586455768`
`63`	`68`	`skipRange, err := bsemver.ParseRange(candidateBundleEntry.SkipRange)`
`64`	`69`	`if err == nil && skipRange(installedBundleVersion) {`
`65`	`70`	`return true`