CoDePretzel / CoDePretzel_Framework

Una infraestructura libre (O/S) de herramientas, técnicas y configuraciones que nos permita desarrollar software embebido de calidad, con facilidad de replicación, modularidad y con un proceso de desarrollo establecido.
Apache License 2.0
0 stars 0 forks source link

Determinar dónde guardar las configuraciones de Platformio para Devices-Boards-Platforms-Frameworks en nuestro repositorio #20

Closed Karosuo closed 1 year ago

Karosuo commented 1 year ago

Las configuraciones en archivos json y py que determinan cómo y con qué propiedades, se va a agregar un custom framework o una board, o una plataform o un device a PlataformIO, necesitan gestionarse por el control de versiones y actualmente no son parte del mismo.

PlatformIO parece tener un repositorio donde se pueden subir los diferentes proyectos (boards, platforms, frameworks), sin embargo esos ya están liberados y se verán cuando sea necesario por el issue #21 .

Este issue está enfocado en proponer una estructura de carpetas donde se puedan guardar dichas configuraciones en nuestro árbol de directorios del repositorio.

Se propone que en el directorio raiz se agregue

pio_confs
|___codepretzel_framework
|___boards
|    |___ArduinoMega
|    |___AVR128DA48
|___platforms
|    |___AVR128DA
|    |___ATMega2560

Y dentro de cada una de esas carpetas irán todos los archivos necesarios para hacer funcionar dicho elemento, así como un README.md que indique el enlace a la parte de la documentación de framework.codereptzel.org donde se indica cómo utilizar dichos archivos. Por ejemplo. Dentro de codepretzel_framework habrá distintos archivos py y json que son necesarios para que en una instalación nueva se pueda agregar un framework custom con la información de nuestro framework y cualquier persona, puede seguir la guía en la documentación oficial y los archivos en esta ubicación y replicar este trabajo.

Karosuo commented 1 year ago

Estoy empezando a pensar que quizá sería mejor idea tenerla en su propio repositorio, así como todas las demás platforms que hay publicadas

Karosuo commented 1 year ago

Respecificado, por lo pronto tendremos una sola platform, que podrá tener distintos boards, si más adelante hay más platforms, se hará un repositorio por cada una, por lo que no se necesitará tener esta estructura en el repo principal.

Si es necesario se agregaría un submodule, pero no parece tener mucho sentido tener esa información en ese repositorio, sobre todo porque se está utilizando el PlatformIO Registry, y se podría hacer un script que ejecute la instalación de losm mismos desde ese registro.

De cualquier manera esta idea puede ser visitada más adelante de ser necesario y re abrir este issue.