44 lines
1.7 KiB
Markdown
44 lines
1.7 KiB
Markdown
# ConfigKit v0.1.1
|
|
|
|
This release corrects the spelling of ConfigKit's reserved configuration key.
|
|
|
|
## Summary
|
|
|
|
The reserved directive key is now `configkit` instead of `_configkit`. Import
|
|
declarations continue to use the same `imports` sequence and path/glob syntax.
|
|
See the [configuration contract](../config.md#explicit-imports).
|
|
|
|
## Compatibility
|
|
|
|
This is an intentional configuration compatibility change, approved as a one-time
|
|
[patch-release exception](../policy/release.md#policy-exceptions) because there are
|
|
no current consumers. `_configkit` is no longer a directive or a reserved key; it
|
|
is ordinary application data and is subject to normal schema validation. There is
|
|
no legacy alias. `configkit` is now reserved, including in nested mappings, profiles,
|
|
and override paths and values.
|
|
|
|
The Go API, diagnostic codes, Go minimum version, and supported platforms are
|
|
unchanged. The private YAML dependency remains pinned to
|
|
`go.yaml.in/yaml/v4 v4.0.0-rc.6`, confirmed as the newest available v4 release
|
|
during candidate preparation.
|
|
|
|
## Upgrade
|
|
|
|
Rename `_configkit` directive keys to `configkit` in root configuration files and
|
|
imported fragments. Rename any application-owned `configkit` fields to avoid the
|
|
newly reserved key. Update diagnostic-path expectations to the new spelling.
|
|
Files retaining `_configkit` will not load their declared imports.
|
|
|
|
Consumers can select this release with:
|
|
|
|
```sh
|
|
go get gitea.maximumdirect.net/eric/ConfigKit@v0.1.1
|
|
```
|
|
|
|
## Changes
|
|
|
|
- Renamed the directive key consistently across imports, profiles, and overrides.
|
|
- Updated current configuration documentation and the composed consumer fixture.
|
|
- Updated behavioral tests and added coverage proving the old spelling is not an
|
|
import alias.
|