[breaking] Renamed gRPC field `cc.arduino.cli.commands.v1.PlatformRelease.type` to `types`

arduino / arduino-cli

Arduino command line tool

GNU General Public License v3.0

4.23k stars 370 forks source link

Please check if the PR fulfills these requirements

See how to contribute

[X] The PR has no duplicates (please search among the Pull Requests before creating one)
[X] The PR follows our contributing guidelines
[ ] Tests for the changes have been added (for bug fixes / features)
[X] Docs have been added / updated (for bug fixes / features)
[X] UPGRADING.md has been updated with a migration guide (for breaking changes)
[ ] configuration.schema.json updated if new parameters are added.

What kind of change does this PR introduce?

Fix the field name in a gRPC message. See #2504 for details.

What is the current behavior?

$ arduino-cli core list --json | jq '.platforms[4].releases."1.8.13"'
{
  "name": "Arduino SAMD (32-bits ARM Cortex-M0+) Boards",
  "version": "1.8.13",
  "type": [
    "Arduino"
  ],
  ...

What is the new behavior?

$ arduino-cli core list --json | jq '.platforms[4].releases."1.8.13"'
{
  "name": "Arduino SAMD (32-bits ARM Cortex-M0+) Boards",
  "version": "1.8.13",
  "types": [
    "Arduino"
  ],
  ...

Does this PR introduce a breaking change, and is titled accordingly?

Yes

Other information

Fix #2504

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 70.30%. Comparing base (81d517b) to head (fc56b44).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## master #2620 +/- ## ======================================= Coverage 70.30% 70.30% ======================================= Files 222 222 Lines 21304 21304 ======================================= Hits 14977 14977 Misses 5151 5151 Partials 1176 1176 ``` | [Flag](https://app.codecov.io/gh/arduino/arduino-cli/pull/2620/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=arduino) | Coverage Δ | | |---|---|---| | [unit](https://app.codecov.io/gh/arduino/arduino-cli/pull/2620/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=arduino) | `70.30% <100.00%> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=arduino#carryforward-flags-in-the-pull-request-comment) to find out more.

arduino / arduino-cli