Skip to content

Document breaking change to config get command output #2676

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 29, 2024
Merged

Document breaking change to config get command output #2676

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1e1d05
Correct typo in Upgrading docs
per1234 Jul 29, 2024
9fa5a99
Document breaking change to `config get` command output
per1234 Jul 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion docs/UPGRADING.md
View file
Open in desktop
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