Récemment, pour un projet open source, j’ai voulu afficher un classement des contributeur en fonction du nombre de commits. J’ai tout de suite eu l’idée de passer par le webservice de Github (alors que je n’en ai jamais entendu parler).
Il est normal que Github ait un webservice, cela permet de faire des nitégration un peut partout (plugin git par exemple).
Contenu
Comment mener sa réflexion du webservice à l’affichage des badges pour récompenser les contributeurs?
L’idée de base est de proposer un classement des contributeurs en fonction du nombre de pull requests. Pour avoir les pull request, il faut avoir les commits sur la branch principale (dans notre cas develop).
Il a fallut d’abord trouver un moyen via la documentation de lister les commits d’une branche. Deplus j’ai pris le parti d’utiliser un token pour avoir moins de restriction sur les appels.
Exemple d’appel sans avoir besoin de clé:
https://api.github.com/user/repos
Appel avec un clé
Il faut d’abord générer une clé, plus exactement un PAT (personal Access Token). Pour ce faire aller à Settings, puis dans la barre de gauche aller dans Developper…
Générer le PAT, sélectionner les droits de ce PAT, je n’ai besoin qu’en lecture, donc cocher comme dans l’image. Je vous propose dans un premier temps d’expérimenter avec Postman, pour ceux qui ne le connaissent pas encore, Postman permet de faire des requêtes HTTP sans navigateur, pratique pour tester des webservices.
Vous aurez les repository du propriétaqire de votre token. Maintenant listons les commits d’une branches, il a fallu explorer la documentation, ne la baclez pas, la documentation est riche.
// lister les branches https://api.github.com/repos/refschool/Clone-Weetransfert/branches // lister les commits de la branche main https://api.github.com/repos/refschool/Clone-Weetransfert/branches/main // lister les commits de la branche par défaut qui est main https://api.github.com/repos/refschool/Clone-Weetransfert/commits // lister les commits de la branche develop avec 100 résultats par page. https://api.github.com/repos/refschool/Clone-Weetransfert/commits?per_page=100&sha=develop
Il faut essayer de se familiariser avec la pagination le jour où l’on a vraiment beaucoup de commit.
Lien vers la documentation:
https://docs.github.com/en/rest/commits/commits?apiVersion=2022-11-28
Mais ne peut on pas lister les pull request?
A l’évidence si ! voici la documentation :
https://docs.github.com/en/rest/pulls/pulls?apiVersion=2022-11-28#list-pull-requests
vous devez être le propriétaire du repo pour avoir les pull requests du projet (normal)