sparkfun / Arduino_Boards

Board definitions for SparkFun-manufactured AVR, ARM, and ESP-based Arduino boards.
263 stars 125 forks source link

changes to package_name and contact email for esp8266 package #70

Closed ubidefeo closed 7 months ago

ubidefeo commented 3 years ago

dear Sparkfun we had some issues while using our CLI when both your boards definitions and Espressif's platforms were installed. I investigated and found out that there was an overlap in package name between yours and Espressif's. Applying this change removes all conflicts and the available platforms for install are correctly displayed when an Arduino CLI user (or workflow) issues a arduino-cli core search esp8266

Sparkfun:esp8266 2.1.2   SparkFun ESP8266 Boards
esp8266:esp8266  2.7.4   esp8266

before only the one maintained by Espressif would show. Hope you'll want to consider this PR

thank you ubi de feo Arduino Tooling Team

ubidefeo commented 3 years ago

I have been digging deeper into your package file, and found out that you had two entries on platforms and tools so I put them all together. They have been tested by placing the index on my server and trying to search/install both ESP32 and esp8266 from your platforms and it worked flawlessly. You might want to run through the changes but I hope you merge it because it can break installation of cores as we found out while working on CLI.

Thanks ubi

ubidefeo commented 2 years ago

@edspark we keep having issues with your esp8266 entry in the index. It conflicts with the official Espressif package, and we're discussing wether/how we should just force out duplicates. If you fix your index replacing esp8266:esp8266 with Sparkfun:esp8266 this would solve a lot of issues. Also as requested please add contact email to that platform branch.

Essentially if you update lines

2428    "email": "ivan@esp8266.com",
2429     "name": "esp8266"

to

2428    "email": "whomever@sparkfun.com",
2429     "name": "Sparkfun"

this would get rid of the conflicts.

Please let us know if this can be done soon, it's creating a lot of issues for users.

thanks ubi

edspark commented 2 years ago

Sorry about the problems; I've went ahead and updated as per your suggestion. I'll get to a new release sometime today or tomorrow.