Objectif
Être alerté quand l'API d'un driver change dans micropython-steami-lib, pour mettre à jour la documentation wiki en conséquence.
Solution proposée
Workflow GitHub Actions (hebdomadaire)
- Cloner micropython-steami-lib
- Extraire les signatures publiques de chaque driver (noms de méthodes, paramètres)
- Comparer avec un snapshot stocké dans le wiki (
scripts/api-snapshot.json)
- Si des différences sont détectées, créer une issue automatiquement
Snapshot API
Fichier JSON généré automatiquement :
{
"ism330dl": {
"ISM330DL": ["__init__", "device_id", "power_on", "power_off", "acceleration_g", "gyroscope_dps", "temperature", "data_ready", "soft_reset"]
},
"wsen_pads": {
"WSENPads": ["__init__", "device_id", "power_on", "power_off", "pressure_hpa", "temperature", "read", "data_ready"]
}
}
Détection de changements
Le script compare le snapshot avec l'API actuelle et signale :
- Méthodes supprimées (breaking change)
- Méthodes renommées (breaking change)
- Méthodes ajoutées (à documenter)
- Paramètres modifiés
Issue automatique
Si des changements sont détectés, le workflow crée une issue listant les drivers modifiés et les méthodes concernées.
Bénéfice
- Détection proactive des changements d'API
- Pas besoin de surveiller manuellement micropython-steami-lib
- Les changements sont documentés avant qu'un utilisateur ne tombe sur une erreur
Objectif
Être alerté quand l'API d'un driver change dans micropython-steami-lib, pour mettre à jour la documentation wiki en conséquence.
Solution proposée
Workflow GitHub Actions (hebdomadaire)
scripts/api-snapshot.json)Snapshot API
Fichier JSON généré automatiquement :
{ "ism330dl": { "ISM330DL": ["__init__", "device_id", "power_on", "power_off", "acceleration_g", "gyroscope_dps", "temperature", "data_ready", "soft_reset"] }, "wsen_pads": { "WSENPads": ["__init__", "device_id", "power_on", "power_off", "pressure_hpa", "temperature", "read", "data_ready"] } }Détection de changements
Le script compare le snapshot avec l'API actuelle et signale :
Issue automatique
Si des changements sont détectés, le workflow crée une issue listant les drivers modifiés et les méthodes concernées.
Bénéfice