From 82f60c6253fb49d5ebff70bbb541c509693d0b19 Mon Sep 17 00:00:00 2001 From: per1234 Date: Mon, 29 Jul 2024 02:25:22 -0700 Subject: [PATCH] Document breaking change to `config get` command output (#2676) * Correct typo in Upgrading docs * Document breaking change to `config get` command output Previously, the `config dump` CLI command returned the effective configuration, including both the values explicitly set via the configuration file and environment variables as well as the values provided by defaults. It was changed to only return the explicitly set configuration data. The breaking change was not documented at that time. --- docs/UPGRADING.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/UPGRADING.md b/docs/UPGRADING.md index 8d57833900c..194c0296332 100644 --- a/docs/UPGRADING.md +++ b/docs/UPGRADING.md @@ -530,12 +530,21 @@ breaking changes as needed. { "sketch_path": "/tmp/my_sketch" } ``` +### `config dump` no longer returns default configuration values + +Previously, the `config dump` CLI command returned the effective configuration, including both the values explicitly set +via the configuration file and environment variables as well as the values provided by defaults. + +It now only returns the explicitly set configuration data. + +Use `config get ` to get the effective value of the configuration + ### The gRPC response `cc.arduino.cli.commands.v1.CompileResponse` has been changed. The `CompilerResponse` message has been refactored to made explicit which fields are intended for streaming the build process and which fields are part of the build result. -The old `CompilerResposne`: +The old `CompilerResponse`: ```protoc message CompileResponse {