This is an automated email from the ASF dual-hosted git repository.
jamesbognar pushed a commit to branch docs
in repository https://gitbox.apache.org/repos/asf/juneau.git
The following commit(s) were added to refs/heads/docs by this push:
new 4948f9ebb5 docs(config): add YAML config topic and 9.5.0 notes
4948f9ebb5 is described below
commit 4948f9ebb51c199e44dc3087d159a83d46649594
Author: James Bognar <[email protected]>
AuthorDate: Fri May 15 12:52:58 2026 -0400
docs(config): add YAML config topic and 9.5.0 notes
Co-authored-by: Cursor <[email protected]>
---
pages/release-notes/9.5.0.md | 9 +++++++
pages/topics/05.15.YamlConfigFiles.md | 50 +++++++++++++++++++++++++++++++++++
sidebars.ts | 5 ++++
3 files changed, 64 insertions(+)
diff --git a/pages/release-notes/9.5.0.md b/pages/release-notes/9.5.0.md
index 154dbf38d6..e57c95e97f 100644
--- a/pages/release-notes/9.5.0.md
+++ b/pages/release-notes/9.5.0.md
@@ -12,6 +12,15 @@ Juneau 9.5.0 is a minor release with native TOML and YAML
support, BSON (Binary
### juneau-commons
+### juneau-config
+
+#### YAML config format support (TODO-32)
+
+- Added optional YAML config support to `juneau-config` alongside the existing
INI/CFG format.
+- Added format selection via config name extension (`.yml` / `.yaml`) and
explicit builder methods (`.yaml()` / `.ini()`).
+- Added path-style section support (e.g. `[foo/bar/baz]`) to align INI
sections with nested YAML mappings.
+- Updated default `FileStore` extension search order to include `cfg,yml,yaml`
(with `cfg` remaining first for backward compatibility).
+
#### Unified Property Source Hierarchy (TODO-27 + TODO-13)
- Added a new property-source SPI naming model: `PropertySource` /
`PropertyStore` and functional variants.
diff --git a/pages/topics/05.15.YamlConfigFiles.md
b/pages/topics/05.15.YamlConfigFiles.md
new file mode 100644
index 0000000000..ba2a0dd256
--- /dev/null
+++ b/pages/topics/05.15.YamlConfigFiles.md
@@ -0,0 +1,50 @@
+---
+title: "YAML Config Files"
+---
+
+# YAML Config Files
+
+`juneau-config` now supports YAML config files as an alternative to INI/CFG
files.
+
+## Enabling YAML
+
+Use a `.yml` or `.yaml` config name to auto-select YAML format:
+
+```java
+Config c = Config.create()
+ .name("MyConfig.yaml")
+ .build();
+```
+
+You can also force YAML explicitly:
+
+```java
+Config c = Config.create()
+ .name("MyConfig.cfg")
+ .yaml()
+ .build();
+```
+
+## Section path mapping
+
+INI section paths map directly to nested YAML maps:
+
+```ini
+[foo/bar/baz]
+k1 = v1
+```
+
+```yaml
+foo:
+ bar:
+ baz:
+ k1: v1
+```
+
+A config lookup like `config.getString("foo/bar/baz/k1")` works the same for
either format.
+
+## Notes
+
+- INI remains the default format.
+- `FileStore` now searches `cfg,yml,yaml` by default.
+- Existing value modifiers and SVL variable resolution continue to work
unchanged.
diff --git a/sidebars.ts b/sidebars.ts
index 3411cf7c0d..c99fcdd69d 100644
--- a/sidebars.ts
+++ b/sidebars.ts
@@ -965,6 +965,11 @@ const sidebars: SidebarsConfig = {
id:
'topics/05.14.SystemDefaultConfig',
label: '5.14. System
Default Config',
},
+ {
+ type: 'doc',
+ id:
'topics/05.15.YamlConfigFiles',
+ label: '5.15. YAML
Config Files',
+ },
],
},
{
