18 lines
1.0 KiB
Go
18 lines
1.0 KiB
Go
// Package configkit loads YAML into an application's Go configuration type and
|
|
// lets the application inspect where the final values came from.
|
|
//
|
|
// Start with Load and a File, Bytes, Reader, Mapping, or Filesystem.File source.
|
|
// Use NoSource for deliberately absent input or SearchConfig for an explicitly
|
|
// chosen search. Applications supply types, defaults, version rules, and callbacks
|
|
// for deriving and validating values. LoadLayered adds lower-priority input groups.
|
|
//
|
|
// A successful load returns the final configuration and saved inspection state.
|
|
// Metadata tracks supplied values, including false and zero; explanations retain
|
|
// safe earlier values. WriteEffective and Diff use the saved state even if the
|
|
// application later changes Result.Config. Secret references resolve credentials
|
|
// during loading, while inspection follows the configured hiding rules.
|
|
//
|
|
// The consumer guide is in docs/consumers/README.md. The exact YAML, combination,
|
|
// lifecycle, and ownership rules are documented in docs/config.md.
|
|
package configkit
|