Version 1.4.1

This patch release includes minor improvements to CLI documentation and code quality (#27), and minor CI improvements (#25).

Version 1.4.0

This minor release includes improvements to documentation (#24), adds String() methods to several fields in the sif package, and deprecates several functions in advance of their removal in a future major version (#22). Minor improvements to code style and testing are also included (#20, #21).

Deprecation

Several FileImage methods have been deprecated in this release:

• func (*FileImage) FmtDescrInfo
• func (*FileImage) FmtDescrList
• func (*FileImage) FmtHeader

See #22 for more details.

Version 1.3.0

This minor release includes significant changes to the underlying I/O implementation to access SIF files. In addition, func (*Descriptor).GetReadSeeker and several fields within struct FileImage have been deprecated.

Removal of Memory Mapped I/O

Previously, the SIF implementation used mmap to memory map the underlying SIF image in certain scenarios. This approach can cause occasional failures when accessing a SIF image that is backed by a non-local filesystem. See #11 for more detail.

Deprecation

func (*Descriptor).GetReadSeeker has been deprecated and will be removed in a future major release. Users should migrate to func (*Descriptor).GetReader. See #14 for more detail.

Several fields in struct FileImage have been deprecated in this release. These fields now have the following behaviour:

• FileImage.Filedata will always be nil. Previously, this contained a non-nil []byte in certain scenarios. Functions such as *FileImage.GetHeader, *Descriptor.GetData, and *Descriptor.GetReadSeeker should now be used to access data within a FileImage.
• FileImage.Amodebuf will always be true, since the underlying file is never memory mapped. Previously, this was false if the underlying file was memory mapped.
• FileImage.Reader will always be nil. Previously, this contained a non-nil *bytes.Reader in certain scenarios. Functions such as *FileImage.GetHeader, *Descriptor.GetData, and *Descriptor.GetReadSeeker should now be used to access data within a FileImage.

Version 1.2.4

This patch release includes code simplification, and minor CI improvements

Version 1.2.3

This patch release updates a dependency to ensure SIF UUIDs are generated with sufficient randomness. Users should take care to ensure they are using a non-vulnerable version of github.com/satori/go.uuid. More information is available in GHSA-4gh8-x3vv-phhg.

Version 1.2.2

This patch release includes dependency updates, minor CI improvements, and bumps the go.mod language version to 1.15.