Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@alessio-perugini
alessio-perugini committed Nov 9, 2023
1 parent edcdefa commit 36a5b2b
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions docs/UPGRADING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,23 @@ Here you can find a list of migration guides to handle breaking changes between
### The gRPC `cc.arduino.cli.commands.v1.PlatformRelease` has been changed.

We've added a new field called `compatible`. This field indicates if the current platform release is installable or not.
It may happen that a platform doesn't have a dependency available for an OS, in such cases, if we try to install the
platform it will fail. The new field can be used to know upfront if a specific release is installable.
It may happen that a platform doesn't have a dependency available for an OS/ARCH, in such cases, if we try to install
the platform it will fail. The new field can be used to know upfront if a specific release is installable.

### The gRPC `cc.arduino.cli.commands.v1.PlatformSummary` has been changed.

We've added a new field called `latest_compatible_version`. This field indicates the latest version that can be
successfully installed for the current OS. The `latest_version` field cannot guarantee such property.
We've modified the behavior of `latest_version`. Now this field indicates the latest version that can be installed in
the current OS/ARCH.

### `core list` now returns only the latest version that can be installed.

Previously, we showed the latest version without checking if all the dependencies were available in the current OS. Now,
the latest version will always point to an installable one even if a newer incompatible one is present.
Previously, we showed the latest version without checking if all the dependencies were available in the current OS/ARCH.
Now, the latest version will always point to an installable one even if a newer incompatible one is present.

### `core search` now shows only the cores that are installable.

Previously, if a core had no installable release it was shown anyway. Now only cores that contain at least 1 installable
releases are returned.

### `core upgrade` and `core install` will install the latest compatible version.

Expand Down

0 comments on commit 36a5b2b

Please sign in to comment.