Fixed comments, and place diagnostic info after the error

Author: mcasperson

octopusdeploy_framework/framework_provider.go

@@ -72,7 +72,12 @@ func (p *octopusDeployFrameworkProvider) Configure(ctx context.Context, req prov
 		resp.Diagnostics.AddError("failed to get root resource", err.Error())
 		config.SystemInfo.OctopusVersion = "Unknown"
 	} else {
-		config.SystemInfo.OctopusVersion = rootResource.Version
+		// Be defensive here because the client can return an empty root resource
+		if rootResource.Version == "" {
+			config.SystemInfo.OctopusVersion = "Unknown"
+		} else {
+			config.SystemInfo.OctopusVersion = rootResource.Version
+		}
 	}
 
 	resp.DataSourceData = &config

octopusdeploy_framework/util/logging.go

@@ -49,10 +49,10 @@ func Updated(ctx context.Context, resource string, v ...any) {
 
 // AddDiagnosticError is used to wrap calls to Diagnostics.AddError with additional information about the executable and versions
 func AddDiagnosticError(diagnostics *diag.Diagnostics, systemInfo *SystemInfo, message string, err string) {
-	suffix := "\nPlease ensure these details are included in any error report you raise.\n" +
+	suffix := "\n\nPlease ensure these details are included in any error report you raise.\n" +
 		"Executable: " + systemInfo.GetExecutableName() + "\n" +
 		"Terraform Version: " + systemInfo.TerraformVersion + "\n" +
 		"Octopus Version: " + systemInfo.OctopusVersion
 
-	diagnostics.AddError(message+suffix, err)
+	diagnostics.AddError(message, err+suffix)
 }