Il s’agit d’un service qui inscrit automatiquement dans un projet GitHub les nouvelles de soutien reçues via Fairy.
Après vous être connecté avec GitHub et avoir relié un élément de soutien à un dépôt, à chaque nouveau soutien reçu, le nom du donateur, le montant du soutien et le message d’encouragement peuvent être enregistrés automatiquement dans le README ou dans le fichier de votre choix. Vous pouvez choisir vous-même, projet par projet, quelles informations rendre publiques.
Il suffit d’enregistrer dans l’onglet webhook de Fairy l’URL Webhook dédiée créée par Fairydust, puis le reste du processus est automatisé.
Vous pouvez également vérifier depuis l’interface d’administration si le soutien reçu a bien été validé et s’il a correctement été répercuté dans le fichier GitHub.
C’est un petit outil d’automatisation destiné aux développeurs qui veulent mieux montrer leur gratitude envers leurs soutiens sans avoir à modifier le README manuellement à chaque fois.
Le nom Fairydust vient de l’idée que la gratitude transmise via Fairy ressemble à une poussière scintillante (Dust) émanant d’une fée.
Fonctionnement
- lors de la connexion GitHub via OAuth, le jeton d’accès de l’utilisateur concerné est chiffré puis stocké
- lorsqu’un événement webhook se produit, le fichier
.mdest modifié puis validé avec le token conservé
À noter
- les commits de modification sont enregistrés avec les informations utilisateur récupérées lors de la connexion
- si l’autorisation OAuth de Fairydust a été révoquée sur GitHub, le service ne fonctionne pas
- le jeton d’accès et la clé secrète du webhook sont stockés chiffrés dans la base de données
- toutes les données sont supprimées immédiatement en cas de désinscription
1 commentaires
Beau sens du naming.
La poussière de fée est mignonne.