add some doc in the code

hashicorp · Jul 28, 2021 · 83fbd8e · 83fbd8e
1 parent 44a0393
commit 83fbd8e
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 5 deletions.
diff --git a/hcl2template/testdata/hcp_par/duplicate.pkr.hcl b/hcl2template/testdata/hcp_par/duplicate.pkr.hcl
@@ -8,4 +8,4 @@ build {
     }
   }
   hcp_packer_registry {}
-}
+}
diff --git a/hcl2template/testdata/hcp_par/empty.pkr.hcl b/hcl2template/testdata/hcp_par/empty.pkr.hcl
@@ -10,3 +10,4 @@ build {
 
 source "virtualbox-iso" "ubuntu-1204" {
 }
+
diff --git a/hcl2template/testdata/hcp_par/invalid.pkr.hcl b/hcl2template/testdata/hcp_par/invalid.pkr.hcl
@@ -4,4 +4,4 @@ build {
   hcp_packer_registry {
     labels = ""
   }
-}
+}
diff --git a/hcl2template/testdata/hcp_par/long-description.pkr.hcl b/hcl2template/testdata/hcp_par/long-description.pkr.hcl
@@ -8,4 +8,4 @@ super super super super super super super super super super super super super su
 super super super long description
     EOT
   }
-}
+}
diff --git a/hcl2template/types.build.go b/hcl2template/types.build.go
@@ -61,6 +61,7 @@ type BuildBlock struct {
 	// call for example.
 	Description string
 
+	// HCPPackerRegistry contains the configuration for publishing the image to the HCP Packer Registry.
 	HCPPackerRegistry *HCPPackerRegistryBlock
 
 	// Sources is the list of sources that we want to start in this build block.

diff --git a/hcl2template/types.build.hcp_packer_registry.go b/hcl2template/types.build.hcp_packer_registry.go
@@ -2,16 +2,19 @@ package hcl2template
 
 import (
 	"fmt"
+
 	"github.com/hashicorp/hcl/v2"
 	"github.com/hashicorp/hcl/v2/gohcl"
 	packerregistry "github.com/hashicorp/packer/internal/packer_registry"
 )
 
 type HCPPackerRegistryBlock struct {
+	// Bucket description
 	Description string
-	Labels      map[string]string
+	// Bucket labels
+	Labels map[string]string
 
-	HCL2Ref HCL2Ref
+	HCL2Ref
 }
 
 func (b *HCPPackerRegistryBlock) WriteBucketConfig(bucket *packerregistry.Bucket) {