Update internal/registry/types.bucket.go

Co-authored-by: Wilken Rivera <[email protected]>
hashicorp · Jun 28, 2022 · 3091024 · 3091024
1 parent 4c11abe
commit 3091024
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/internal/registry/types.bucket.go b/internal/registry/types.bucket.go
@@ -144,6 +144,7 @@ func (b *Bucket) CreateInitialBuildForIteration(ctx context.Context, componentTy
 }
 
 // UpdateBuildStatus updates the status of a build entry on the HCP Packer registry with its current local status.
+// For updating a build status to DONE use CompleteBuild.
 func (b *Bucket) UpdateBuildStatus(ctx context.Context, name string, status models.HashicorpCloudPackerBuildStatus) error {
 	if status == models.HashicorpCloudPackerBuildStatusDONE {
 		return fmt.Errorf("do not use UpdateBuildStatus for updating to DONE")