Skip to content

Commit 339242e

Browse files
Document changes in UPGRADING.md
1 parent 748c439 commit 339242e

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

Diff for: docs/UPGRADING.md

+25
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,31 @@
22

33
Here you can find a list of migration guides to handle breaking changes between releases of the CLI.
44

5+
## 0.31.0
6+
7+
### Added `post_install` script support for tools
8+
9+
The `post_install` script now runs when a tool is correctly installed and the CLI is in "interactive" mode. This
10+
behavior can be [configured](https://arduino.github.io/arduino-cli/0.30/commands/arduino-cli_core_install/#options).
11+
12+
### golang API: methods in `github.com/arduino/arduino-cli/arduino/cores/packagemanager` changed signature
13+
14+
The following methods in `github.com/arduino/arduino-cli/arduino/cores/packagemanager`:
15+
16+
```go
17+
func (pme *Explorer) InstallTool(toolRelease *cores.ToolRelease, taskCB rpc.TaskProgressCB) error { ... }
18+
func (pme *Explorer) RunPostInstallScript(platformRelease *cores.PlatformRelease) error { ... }
19+
```
20+
21+
have changed. `InstallTool` requires the new `skipPostInstall` parameter, which must be set to `true` to skip the post
22+
install script. `RunPostInstallScript` does not require a `*cores.PlatformRelease` parameter but requires a
23+
`*paths.Path` parameter:
24+
25+
```go
26+
func (pme *Explorer) InstallTool(toolRelease *cores.ToolRelease, taskCB rpc.TaskProgressCB, skipPostInstall bool) error {...}
27+
func (pme *Explorer) RunPostInstallScript(installDir *paths.Path) error { ... }
28+
```
29+
530
## 0.30.0
631

732
### Sketch name validation

0 commit comments

Comments
 (0)