Skip to content

Commit

Permalink
Document breaking change to config get command output (#2676)
Browse files Browse the repository at this point in the history
* 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.
  • Loading branch information
per1234 authored Jul 29, 2024
1 parent b8c927b commit 82f60c6
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion docs/UPGRADING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <configuration key>` 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 {
Expand Down

0 comments on commit 82f60c6

Please sign in to comment.