Notify user when managed platform is not tracked by a package index #2088
Labels
Comments
per1234
added
type: enhancement
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe the request
If an installed Arduino boards platform was installed via Boards Manager, but that platform is not listed in the primary package index or an additional package index configured via the "Additional Boards Manager URLs" preference, display a warning notification to the user:
I think the most appropriate time to check for this condition and display the notification is during the package index update process.
🙂 The user will be aware that Boards Manager updates for the platform will not be available due to the missing URL in their preferences.
Describe the current behavior
The Boards Manager system provides installation and updates of Arduino boards platforms. Arduino maintains a primary package index that provides all official and partner platforms. A huge number of 3rd party platforms are also available. In order to access these, the user must add the URL to the platform's package index to the "Additional Boards Manager URLs" field of their Arduino IDE preferences.
After a platform is installed, it remains usable even if the additional package index URL is removed from the "Additional Boards Manager URLs" preference. However, the presence of this URL is required for the valuable update capability of Boards Manager to work. Users without an in depth understanding of the fairly complex and esoteric Boards Manager system may not be aware of this and thus feel no need to maintain a list of URLs in their "Additional Boards Manager URLs" preference.
There are several scenarios that would make this especially likely to occur:
🙁 The "untracked" status of the platform is not communicated to the user. They may miss out on important advancements made in later releases of the platform or else be confused when the Boards Manager update capability does not seem to work.
Arduino IDE version
e47fb2e
Operating system
All
Operating system version
Any
Additional context
The untracked condition is indicated by the
indexedfield of thecc.arduino.cli.commands.v1.Platformmessage not being set totrue.That capability was added by arduino/arduino-cli#2174 and will be introduced into Arduino IDE by #2083
❗ The notification should not be displayed for "unmanaged" (manually installed) platforms, since the "untracked" state is inherent to these platforms. They are identified by the
manually_installedfield of thecc.arduino.cli.commands.v1.Platformmessage being set totrue.This will effectively resolve #1524.
The approach proposed here is superior to the alternative solution for #1524 of automatically migrating the URLs from the Arduino IDE 1.x preferences store.
The reason this approach is superior is because it addresses the problem of untracked managed platforms in general and thus improves the user experience beyond the 1.x to 2.x IDE upgrade alone. It should also be fairly easy to implement since Arduino CLI is already indicating the "untracked" state.
The fairly complex code that would be needed for the alternative approach of migrating the 1.x preferences would only provide a one time benefit for the ever diminishing subset of users who are upgrading from Arduino IDE 1.x.
Related:
Issue checklist
The text was updated successfully, but these errors were encountered: