diff --git a/example_pack_test.go b/example_pack_test.go index 169e0911..9adf8fae 100644 --- a/example_pack_test.go +++ b/example_pack_test.go @@ -34,7 +34,7 @@ func ExamplePackManifest_imageV11() { // 1. Set optional parameters opts := oras.PackManifestOptions{ ManifestAnnotations: map[string]string{ - // this timestamp will be automatically generated if not specified + // this time stamp will be automatically generated if not specified // use a fixed value here to make the pack result reproducible ocispec.AnnotationCreated: "2000-01-01T00:00:00Z", }, @@ -70,7 +70,7 @@ func ExamplePackManifest_imageV10() { // 1. Set optional parameters opts := oras.PackManifestOptions{ ManifestAnnotations: map[string]string{ - // this timestamp will be automatically generated if not specified + // this time stamp will be automatically generated if not specified // use a fixed value here to make the pack result reproducible ocispec.AnnotationCreated: "2000-01-01T00:00:00Z", }, diff --git a/pack.go b/pack.go index 969dc3ac..d67388a7 100644 --- a/pack.go +++ b/pack.go @@ -94,8 +94,9 @@ type PackManifestOptions struct { Layers []ocispec.Descriptor // ManifestAnnotations is the annotation map of the manifest. In order to - // make PackManifest reproducible, set the key ocispec.AnnotationCreated to - // a fixed value. The value must conform to RFC 3339. + // make [PackManifest] reproducible, set the key ocispec.AnnotationCreated + // (i.e. "org.opencontainers.image.created") to a fixed value. The value + // must conform to RFC 3339. ManifestAnnotations map[string]string // ConfigDescriptor is a pointer to the descriptor of the config blob. @@ -128,10 +129,11 @@ var mediaTypeRegexp = regexp.MustCompile(`^[A-Za-z0-9][A-Za-z0-9!#$&-^_.+]{0,126 // // artifactType and opts.ConfigDescriptor.MediaType MUST comply with RFC 6838. // -// Each time when PackManifest is called, it generates a new time stamp in the -// manifest annotations with the key ocispec.AnnotationCreated. To make -// PackManifest reproducible, set the key ocispec.AnnotationCreated to a fixed value -// in opts.ManifestAnnotations. The value MUST conform to RFC 3339. +// Each time when PackManifest is called, if a time stamp is not specified, a new time +// stamp is generated in the manifest annotations with the key ocispec.AnnotationCreated +// (i.e. "org.opencontainers.image.created"). To make [PackManifest] reproducible, +// set the key ocispec.AnnotationCreated to a fixed value in +// opts.ManifestAnnotations. The value MUST conform to RFC 3339. // // If succeeded, returns a descriptor of the packed manifest. func PackManifest(ctx context.Context, pusher content.Pusher, packManifestVersion PackManifestVersion, artifactType string, opts PackManifestOptions) (ocispec.Descriptor, error) {