Skip to content

Commit 48f0235

Browse files
committed
Added note on breaking API change
1 parent b54e7e4 commit 48f0235

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

Diff for: docs/UPGRADING.md

+17
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,23 @@ Here you can find a list of migration guides to handle breaking changes between
44

55
## Unreleased
66

7+
### `commands.Compile` function change
8+
9+
A new argument `progressCB` has been added to `commands.Compile`, the new function signature is:
10+
11+
```go
12+
func Compile(
13+
ctx context.Context,
14+
req *rpc.CompileRequest,
15+
outStream, errStream io.Writer,
16+
progressCB commands.TaskProgressCB,
17+
debug bool
18+
) (r *rpc.CompileResponse, e error) {
19+
```
20+
21+
if a callback function is provided the `Compile` command will call it periodically with progress reports with the
22+
percentage of compilation completed, otherwise, if the parameter is `nil`, no progress reports will be performed.
23+
724
### `github.com/arduino/arduino-cli/cli/arguments.ParseReferences` function change
825
926
The `parseArch` parameter was removed since it was unused and was always true. This means that the architecture gets

0 commit comments

Comments
 (0)