Added changeset for config $include

2021-01-04 15:43:04 +01:00
parent 36268a966c
commit ad5c56fd9e
1 changed files with 20 additions and 0 deletions
@@ -0,0 +1,20 @@
+---
+'@backstage/config-loader': patch
+---
+
+Deprecate `$data` and replace it with `$include` which allows for any type of json value to be read from external files. In addition, `$include` can be used without a path, which causes the value at the root of the file to be loaded.
+
+Most usages of `$data` can be directly replaced with `$include`, expect for if the referenced value is not a string, in which case the value needs to be changed. For example:
+
+```yaml
+# app-config.yaml
+foo:
+  $data: foo.yaml#myValue # replacing with $include will turn the value into a number
+  $data: bar.yaml#myValue # replacing with $include is safe
+
+# foo.yaml
+myValue: 0xf00
+
+# bar.yaml
+myValue: bar
+```