Skip to content

Commit 174c2db

Browse files
committed
Updated docs
1 parent 79d2410 commit 174c2db

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

docs/UPGRADING.md

+23
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,29 @@ The `sketch.json` file is now completely ignored.
1616
The `cc.arduino.cli.commands.v1.BoardAttach` gRPC command has been removed. This feature is no longer available through
1717
gRPC.
1818

19+
### golang API change in `github.com/arduino/arduino-cli/arduino/libraries/librariesmanager.LibrariesManager`
20+
21+
The following `LibrariesManager.InstallPrerequisiteCheck` methods have changed prototype, from:
22+
23+
```go
24+
func (lm *LibrariesManager) InstallPrerequisiteCheck(indexLibrary *librariesindex.Release, installLocation libraries.LibraryLocation) (*paths.Path, *libraries.Library, error) { ... }
25+
func (lm *LibrariesManager) InstallZipLib(ctx context.Context, archivePath string, overwrite bool) error { ... }
26+
```
27+
28+
to
29+
30+
```go
31+
func (lm *LibrariesManager) InstallPrerequisiteCheck(indexLibrary *librariesindex.Release, installLocation libraries.LibraryLocation) (*paths.Path, *libraries.Library, error) { ... }
32+
func (lm *LibrariesManager) InstallZipLib(ctx context.Context, archivePath *paths.Path, overwrite bool) error { ... }
33+
```
34+
35+
`InstallPrerequisiteCheck` now requires an explicit `name` and `version` instead of a `librariesindex.Release`, becuase
36+
it can now be used to check any library, not only the libraries available in the index. Also the return value has
37+
changed to a `LibraryInstallPlan` structure, it contains the same information as before (`TargetPath` and `ReplacedLib`)
38+
plus `Name`, `Version`, and an `UpToDate` boolean flag.
39+
40+
`InstallZipLib` method `archivePath` is now a `paths.Path` instead of a `string`.
41+
1942
## 0.29.0
2043

2144
### Removed gRPC API: `cc.arduino.cli.commands.v1.UpdateCoreLibrariesIndex`, `Outdated`, and `Upgrade`

0 commit comments

Comments
 (0)