Version 1.5.1

Changed

• Improved generated documentation for environment variables that use RelevantIf() or ReleventWhen() options.

Version 1.5.0

Added

• Added ReleventWhen() option, which conditionally enables an environment variable when another variable has a specific value.

Changed

The following changes are technically not backwards compatible from a Go perspective, but under normal usage (as per the examples) they do not actually alter the usage of the Ferrite API:

• Changed the VariableSet to accept a type parameter for the value produced.
• Changed ReleventIf(), SeeAlso() and SupersededBy() to accept a type parameter for the value produced.

Version 1.4.0

Added

• Added FileBuilder.WithMustExist() constraint.
• Added Dir() builder for directory paths.

Changed

• Bumped minimum Go version to v1.22.

Version 1.3.0

Added

• Added StringBuilder.WithMinimumLength(), WithMaximumLength(), WithLength().
• Added BytesBuilder.WithMinimumLength(), WithMaximumLength(), WithLength().

Fixed

• Fixed wording of error message when a variable exceeds the maximum length.

Version 1.2.1

Changed

• Dropped support for Go v1.19, which reached end-of-life on 2023-08-08
• Removed use of the slices and maps packages from golang.org/x/exp. These package are not versioned and as such breaking changes can cause conflicts with other dependencies. The experimental constraints package is still used, with the expectation that these will always remain valid for use as type parameter constraints.

Version 1.2.0

Added

• Added Registry and NewRegistry()
• Added RegistryOption and WithDocumentationURL()

Changed

• Changed WithRegistry() to accept a ferrite.Registry instead of the experimental variable.Registry type
• Passing WithRegistry() to Init() is now additive, instead of replacing the default registry

Removed

• Removed the experimental maybe and variable sub-packages

Fixed

• Prevent registration of multiple environment variables with the same name

Version 1.1.0

Added

• Added Binary() and BinaryAs() builders for binary variables
• Added variable.LengthLimited schema for values that have minimum or maximum lengths

Changed

• variable.String now implements the new LengthLimited interface
• Rename the variable.[Min|Max]LengthError.String to ViolatedSchema and change its type to LengthLimited

Removed

• Removed "platform" examples from generated documentation. These are too opinionated and organization-specific to be included in every project's documentation. Instead, we will provide different export modes that can be used to generate Docker/Kubernetes/etc configurations, similar to the existing export/dotenv mode.

Version 1.0.3

Changed

• export/dotenv mode now includes sensitive values in the output

Version 1.0.2

Fixed

• Added export keyword to output of export/dotenv mode

Changed

• Improve example values for File() builder

Version 1.0.1

Changed

• Render a table of environment variables in Markdown documentation instead of bullet points
• Simplify language in generated documentation