|
2 | 2 |
|
3 | 3 | Here you can find a list of migration guides to handle breaking changes between releases of the CLI.
|
4 | 4 |
|
| 5 | +## 0.26.0 |
| 6 | + |
| 7 | +### `github.com/arduino/arduino-cli/commands.DownloadToolRelease`, and `InstallToolRelease` functions have been removed |
| 8 | + |
| 9 | +This functionality was duplicated and already available via `PackageManager` methods. |
| 10 | + |
| 11 | +### `github.com/arduino/arduino-cli/commands.Outdated` and `Upgrade` functions have been moved |
| 12 | + |
| 13 | +- `github.com/arduino/arduino-cli/commands.Outdated` is now `github.com/arduino/arduino-cli/commands/outdated.Outdated` |
| 14 | +- `github.com/arduino/arduino-cli/commands.Upgrade` is now `github.com/arduino/arduino-cli/commands/upgrade.Upgrade` |
| 15 | + |
| 16 | +Old code must change the imports accordingly. |
| 17 | + |
| 18 | +### `github.com/arduino-cli/arduino/cores/packagemanager.PackageManager` methods and fields change |
| 19 | + |
| 20 | +- The `PackageManager.Log` and `TempDir` fields are now private. |
| 21 | + |
| 22 | +- The `PackageManager.DownloadToolRelease` method has no more the `label` parameter: |
| 23 | + |
| 24 | + ```go |
| 25 | + func (pm *PackageManager) DownloadToolRelease(tool *cores.ToolRelease, config *downloader.Config, label string, progressCB rpc.DownloadProgressCB) error { |
| 26 | + ``` |
| 27 | +
|
| 28 | + has been changed to: |
| 29 | +
|
| 30 | + ```go |
| 31 | + func (pm *PackageManager) DownloadToolRelease(tool *cores.ToolRelease, config *downloader.Config, progressCB rpc.DownloadProgressCB) error { |
| 32 | + ``` |
| 33 | +
|
| 34 | + Old code should remove the `label` parameter. |
| 35 | +
|
| 36 | +- The `PackageManager.UninstallPlatform`, `PackageManager.InstallTool`, and `PackageManager.UninstallTool` methods now |
| 37 | + requires a `github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1.TaskProgressCB` |
| 38 | +
|
| 39 | + ```go |
| 40 | + func (pm *PackageManager) UninstallPlatform(platformRelease *cores.PlatformRelease) error { |
| 41 | + func (pm *PackageManager) InstallTool(toolRelease *cores.ToolRelease) error { |
| 42 | + func (pm *PackageManager) UninstallTool(toolRelease *cores.ToolRelease) error { |
| 43 | + ``` |
| 44 | +
|
| 45 | + have been changed to: |
| 46 | +
|
| 47 | + ```go |
| 48 | + func (pm *PackageManager) UninstallPlatform(platformRelease *cores.PlatformRelease, taskCB rpc.TaskProgressCB) error { |
| 49 | + func (pm *PackageManager) InstallTool(toolRelease *cores.ToolRelease, taskCB rpc.TaskProgressCB) error { |
| 50 | + func (pm *PackageManager) UninstallTool(toolRelease *cores.ToolRelease, taskCB rpc.TaskProgressCB) error { |
| 51 | + ``` |
| 52 | +
|
| 53 | + If you're not interested in getting the task events you can pass an empty callback function. |
| 54 | +
|
5 | 55 | ## 0.25.0
|
6 | 56 |
|
7 | 57 | ### go-lang function `github.com/arduino/arduino-cli/arduino/utils.FeedStreamTo` has been changed
|
|
0 commit comments