Skip to content

Commit 3e0cf80

Browse files
committed
Added docs
1 parent 8df8033 commit 3e0cf80

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

docs/UPGRADING.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,39 @@ Here you can find a list of migration guides to handle breaking changes between
44

55
## 0.22.0
66

7+
### `github.com/arduino/arduino-cli/arduino.MultipleBoardsDetectedError` field changed type
8+
9+
Now the `Port` field of the error is a `github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1.Port`, usually
10+
imported as `rpc.Port`. The old `discovery.Port` can be converted to the new one using the `.ToRPC()` method.
11+
12+
### Function `github.com/arduino/arduino-cli/commands/upload.DetectConnectedBoard(...)` has been removed
13+
14+
Use `github.com/arduino/arduino-cli/commands/board.List(...)` to detect boards.
15+
16+
### Function `arguments.GetDiscoveryPort(...)` has been removed
17+
18+
NOTE: the functions in the `arguments` package doesn't have much use outside of the `arduino-cli` so we are considering
19+
to remove them from the public golang API making them `internal`.
20+
21+
The old function:
22+
23+
```go
24+
func (p *Port) GetDiscoveryPort(instance *rpc.Instance, sk *sketch.Sketch) *discovery.Port { }
25+
```
26+
27+
is now replaced by the more powerful:
28+
29+
```go
30+
func (p *Port) DetectFQBN(inst *rpc.Instance) (string, *rpc.Port) { }
31+
32+
func CalculateFQBNAndPort(portArgs *Port, fqbnArg *Fqbn, instance *rpc.Instance, sk *sketch.Sketch) (string, *rpc.Port) { }
33+
```
34+
35+
### gRPC: `address` parameter has been removed from `commands.SupportedUserFieldsRequest`
36+
37+
The parameter is no more needed. Lagacy code will continue to work without modification (the value of the parameter will
38+
be just ignored).
39+
740
### The content of package `github.com/arduino/arduino-cli/httpclient` has been moved to a different path
841

942
In particular:

0 commit comments

Comments
 (0)