Skip to content

Commit 9102b90

Browse files
committed
Added docs
1 parent 75116fc commit 9102b90

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

docs/UPGRADING.md

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

939
In particular:

0 commit comments

Comments
 (0)