Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
alessio-perugini committed Nov 7, 2023
1 parent 88f7058 commit 144e5a3
Showing 1 changed file with 50 additions and 0 deletions.
50 changes: 50 additions & 0 deletions docs/UPGRADING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,56 @@ Here you can find a list of migration guides to handle breaking changes between

## 0.36.0

### CLI changed JSON output for some `lib`, `core`, `config`, `board`, and `sketch` commands.

- `arduino-cli lib list` results are wrapped under `installed_libraries` key

```
{ "installed_libraries": [ {...}, {...} ] }
```

- `arduino-cli lib list` results are wrapped under `examples` key

```
{ "examples": [ {...}, {...} ] }
```

- `arduino-cli core search` and `arduino-cli core list` results are wrapped under `platforms` key

```
{ "platforms": [ {...}, {...} ] }
```

- `arduino-cli config init` now correctly returns a json containg the config path

```
{ "config_path": "/home/user/.arduino15/arduino-cli.yaml" }
```

- `arduino-cli core dump` results are wrapped under `config` key

```
{ "config": { ... } }
```

- `arduino-cli board search` results are wrapped under `boards` key

```
{ "boards": [ {...}, {...} ] }
```

- `arduino-cli board list` results are wrapped under `detected_ports` key

```
{ "detected_ports": [ {...}, {...} ] }
```

- `arduino-cli sketch new` now correctly returns a json containing the sketch path

```
{ "sketch_path": "/tmp/my_sketch" }
```

### gRPC `cc.arduino.cli.commands.v1.LibrarySearchRequest` message has been changed.

The `query` field has been removed, use `search_args` instead.
Expand Down

0 comments on commit 144e5a3

Please sign in to comment.