fix version embedding for provider version (#593)

Setting version using ldflags is brittle, and seems not to work the way
goreleaser does it today. Instead, let's just get our version from
`BuildInfo` which is more reliable.

Signed-off-by: Jason Hall <[email protected]>

Author: imjasonh

.goreleaser.yml

@@ -12,8 +12,6 @@ builds:
   mod_timestamp: '{{ .CommitTimestamp }}'
   flags:
     - -trimpath
-  ldflags:
-    - '-s -w -X main.version={{.Version}} -X main.commit={{.Commit}}'
   goos:
     - linux
     - darwin

internal/provider/layering_validation_test.go

@@ -14,7 +14,7 @@ func TestLayeringStrategyValidation(t *testing.T) {
 	resource.Test(t, resource.TestCase{
 		PreCheck: func() { testAccPreCheck(t) },
 		ProtoV6ProviderFactories: map[string]func() (tfprotov6.ProviderServer, error){
-			"apko": providerserver.NewProtocol6WithError(New("test")()),
+			"apko": providerserver.NewProtocol6WithError(New()()),
 		},
 		Steps: []resource.TestStep{
 			{
@@ -48,7 +48,7 @@ func TestLayeringBudgetValidation(t *testing.T) {
 	resource.Test(t, resource.TestCase{
 		PreCheck: func() { testAccPreCheck(t) },
 		ProtoV6ProviderFactories: map[string]func() (tfprotov6.ProviderServer, error){
-			"apko": providerserver.NewProtocol6WithError(New("test")()),
+			"apko": providerserver.NewProtocol6WithError(New()()),
 		},
 		Steps: []resource.TestStep{
 			{

internal/provider/provider.go

@@ -2,6 +2,7 @@ package provider
 
 import (
 	"context"
+	"runtime/debug"
 	"time"
 
 	"chainguard.dev/apko/pkg/apk/apk"
@@ -205,10 +206,21 @@ func (p *Provider) Functions(ctx context.Context) []func() function.Function {
 	}
 }
 
-func New(version string) func() provider.Provider {
+// getVersion attempts to get the version from build info.
+func getVersion() string {
+	if info, ok := debug.ReadBuildInfo(); ok {
+		// When built with goreleaser, this will be the actual version
+		if info.Main.Version != "" && info.Main.Version != "(devel)" {
+			return info.Main.Version
+		}
+	}
+	return "dev"
+}
+
+func New() func() provider.Provider {
 	return func() provider.Provider {
 		return &Provider{
-			version: version,
+			version: getVersion(),
 		}
 	}
 }

internal/provider/provider_test.go

@@ -12,7 +12,7 @@ import (
 // CLI command executed to create a provider server to which the CLI can
 // reattach.
 var testAccProtoV6ProviderFactories = map[string]func() (tfprotov6.ProviderServer, error){
-	"apko": providerserver.NewProtocol6WithError(New("test")()),
+	"apko": providerserver.NewProtocol6WithError(New()()),
 }
 
 func testAccPreCheck(t *testing.T) {

internal/provider/version_function_test.go

@@ -25,8 +25,9 @@ output "apko_version" {
   value = local.version_info.apko_version
 }`,
 			Check: resource.ComposeTestCheckFunc(
-				// Check that the provider version is "test" (as set in testAccProtoV6ProviderFactories)
-				resource.TestCheckOutput("provider_version", "test"),
+				// Check that the provider version is not empty and looks like a version
+				// With build info, it should be something like "v0.23.1-0.20250729145754-7f4b7167d62c" or "dev"
+				resource.TestMatchOutput("provider_version", regexp.MustCompile(`^(v\d+\.\d+\.\d+.*|dev)$`)),
 				// Check that apko version is not empty and looks like a version
 				resource.TestMatchOutput("apko_version", regexp.MustCompile(`^v\d+\.\d+\.\d+.*|unknown$`)),
 			),

main.go

@@ -14,8 +14,6 @@ import (
 //go:generate terraform fmt -recursive ./examples/
 //go:generate go run github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs
 
-const version string = "dev"
-
 func main() {
 	var debug bool
 	flag.BoolVar(&debug, "debug", false, "set to true to run the provider with support for debuggers like delve")
@@ -26,7 +24,7 @@ func main() {
 		Debug:   debug,
 	}
 
-	if err := providerserver.Serve(context.Background(), provider.New(version), opts); err != nil {
+	if err := providerserver.Serve(context.Background(), provider.New(), opts); err != nil {
 		log.Fatal(err.Error())
 	}
 }