pkg/reference: deprecate SplitObject

thaJeztah · thaJeztah · commit fec33aa7359e · 2024-06-27T22:11:42.000+02:00
The behavior of this function is quite counter-intuitive, as it preserves
the delimiter in the result, and its use for external consumers would be
very limited.

Spec.Digest no longer uses this function, and it appears that BuildKit is
currently the only (publicly visible) external consumer of it.

This patch deprecates the function.

Signed-off-by: Sebastiaan van Stijn &lt;github@gone.nl&gt;
diff --git a/pkg/reference/reference.go b/pkg/reference/reference.go
@@ -168,6 +168,8 @@ func (r Spec) String() string {
 //	t, d := SplitObject("docker.io/library/ubuntu:latest@sha256:deadbeef")
 //	fmt.Println(t) // docker.io/library/ubuntu:latest@
 //	fmt.Println(d) // sha256:deadbeef
+//
+// Deprecated: use [Parse] and [Spec.Digest] instead.
 func SplitObject(obj string) (tag string, dgst digest.Digest) {
 	if i := strings.Index(obj, "@"); i >= 0 {
 		// Offset by one so preserve the "@" in the tag returned.
