Qu’est-ce qu’une animation snake des contributions GitHub ?
Une animation snake des contributions GitHub est une ressource visuelle générée depuis le graphe que GitHub affiche pour un compte. Le serpent parcourt les cases du calendrier et produit un SVG ou un GIF intégrable à un README de profil. C’est une couche de présentation : elle ne crée pas de contributions, ne répare pas une activité absente et ne modifie pas l’historique du dépôt.
Le dépôt Platane/snk documente les sorties GIF et SVG ainsi qu’une GitHub Action qui reçoit un nom d’utilisateur et des chemins de sortie. Le workflow peut écrire un fichier comme dist/github-snake.svg dans le dépôt qui sert le README. Le projet décrit aussi une action SVG-only plus rapide.
Cette séparation est utile lorsque la snake semble vide. Commencez par le graphe officiel du profil et vérifiez que l’activité attendue y apparaît. L’adresse e-mail du commit, la branche, le fork, le dépôt, la visibilité et le délai de traitement peuvent expliquer une différence entre l’historique et le profil. Si la source est incomplète, relancer la génération ne fera qu’animer des données incomplètes.
Pour une image fixe, consultez le guide PNG des contributions. Pour un README de profil avec projets et liens autour de l’animation, lisez le guide du README de profil. La snake a une fonction précise : rendre le calendrier vivant dans une ressource compacte et compréhensible.
Configurer une animation snake des contributions GitHub
La configuration est plus simple lorsque le fichier généré se trouve dans un dossier prévisible et qu’un workflow unique le met à jour. Partez de la syntaxe officielle, puis adaptez le chemin au dépôt qui publie votre README.
Choisir le dépôt qui héberge la ressource
Un README de profil est généralement servi par le dépôt dont le nom correspond à l’utilisateur GitHub. Confirmez ce dépôt et sa branche par défaut avant d’ajouter le workflow.
Ajouter un workflow GitHub Actions planifié
Créez un fichier dans .github/workflows/ et utilisez l’action documentée Platane/snk@v1. Passez le nom avec github_user_name; le contexte du propriétaire convient au dépôt de profil.
Choisir SVG, GIF ou les deux
Utilisez svg_out_path pour une ressource légère et facile à intégrer. Ajoutez gif_out_path seulement si le mouvement est utile et si la taille supplémentaire est acceptable.
Committer le fichier dans un chemin stable
Gardez la sortie dans un dossier comme dist/ et vérifiez les permissions qui autorisent l’action à mettre le fichier à jour. Un dossier temporaire du runner ne peut pas être lu par le README.
Insérer l’URL réelle dans README.md
Référencez le SVG ou le GIF avec une URL raw GitHub, ou un chemin relatif quand les deux fichiers vivent ensemble. Ouvrez ensuite le profil publié, pas seulement le journal Actions.
Fichiers, sorties et contrôles de mise à jour
Quatre emplacements ont des responsabilités différentes. Le workflow indique quand l’action s’exécute ; le fichier généré est la sortie ; README.md est la présentation publique ; le graphe officiel vérifie la source. Séparer ces couches permet d’isoler rapidement un défaut.
Un workflow planifié peut rafraîchir la ressource après le traitement d’une nouvelle activité, mais une exécution réussie ne garantit pas que chaque commit local apparaisse. GitHub doit traiter le graphe et l’action ne lit pas les activités privées ou non comptées. La date du fichier est un indice de maintenance, pas une mesure du travail.
Gardez le README accessible. Ajoutez un lien ou une courte explication près de l’animation et prévoyez une alternative statique pour les lecteurs qui désactivent le mouvement. L’image doit soutenir les projets et la documentation, non les remplacer.
| Couche | Rôle | Contrôle avant partage |
|---|---|---|
| .github/workflows/*.yml | Lancer l’action manuellement ou selon un horaire. | Utilisateur, version, permissions et déclencheur sont explicites. |
| dist/github-snake.svg | Conserver l’animation vectorielle générée. | Le fichier existe sur la branche citée par le README. |
| dist/github-snake.gif | Alternative raster animée facultative. | La taille et le mouvement justifient son usage. |
| README.md | Présenter la ressource avec le contexte du profil. | L’URL raw ou relative charge lors d’une visite propre. |
| Graphe du profil | Vérifier la source lue par la snake. | Les contributions attendues apparaissent après traitement. |
Snake et autres visuels de contributions GitHub
Les formats peuvent partager les mêmes données tout en répondant à des besoins différents. Choisissez le visuel minimal qui répond à la question du lecteur et liez une explication plus détaillée quand les règles comptent.
Choisir une snake pour le mouvement dans un README
Elle est compacte et ludique quand les cases sont comprises comme des contributions. Ajoutez du texte et une alternative fixe si nécessaire.
Choisir un PNG pour une capture stable
Le PNG convient au portfolio, aux présentations et aux documents imprimés. Il permet de légender une période précise sans dépendre d’un mouvement.
Choisir Profile 3D Contrib pour une image 3D automatisée
Un calendrier 3D généré par workflow convient à une image plus riche commitée dans le dépôt de profil. Son installation diffère de celle d’une snake.
Choisir GitHub City pour l’exploration 3D
GitHub City transforme l’activité visible en scène urbaine interactive dans le navigateur. C’est une couche visuelle distincte, pas un remplacement du workflow README.
Pourquoi la snake GitHub est vide ou ancienne
Une snake vide indique souvent un problème de graphe source, de sortie du workflow ou d’URL du README. Vérifiez ces trois couches dans cet ordre. Ouvrez le profil public, puis le journal Actions, puis l’URL directe du fichier commitée au lieu de vous fier à une page en cache.
Si le graphe ne contient pas l’activité, contrôlez l’adresse e-mail du commit, la branche, le dépôt ou le fork, la visibilité des contributions privées et le délai de traitement. L’historique d’un dépôt et le graphe du profil répondent à des questions différentes ; un commit peut être présent dans l’un et attendre dans l’autre.
Si le graphe est correct mais le fichier est ancien, vérifiez le déclencheur, l’horaire, le journal de l’action, le chemin de sortie et la branche utilisée par le README. Si le fichier existe mais qu’une vieille image apparaît, inspectez l’URL raw, les doublons de nom et le cache avant de modifier encore le workflow.
Ordre de diagnostic
Graphe du profil, journal Actions, sortie commitée, puis intégration README. Corriger l’URL de présentation avant de vérifier les données peut masquer la cause.
FAQ de l’animation snake des contributions GitHub
Qu’est-ce qu’une animation snake des contributions GitHub ?
C’est un SVG ou un GIF généré depuis le graphe de contributions visible d’un utilisateur. Le serpent parcourt les cases dans un README ; il ne crée pas de contributions.
Quel dépôt doit contenir l’image ?
Pour un README de profil, utilisez le dépôt dont le nom correspond à l’utilisateur GitHub. Enregistrez le fichier dans un dossier stable de la branche référencée.
Faut-il choisir SVG ou GIF ?
Le SVG est généralement le choix léger pour un README. Le GIF ajoute du mouvement mais exige un contrôle de taille, de chargement et une alternative fixe si besoin.
À quelle fréquence la snake se met-elle à jour ?
Elle se met à jour lorsque le workflow s’exécute et que le graphe est disponible pour l’action. L’horaire et le traitement GitHub déterminent le moment réel.
Pourquoi mes commits récents n’apparaissent-ils pas ?
Vérifiez d’abord le graphe officiel, puis l’e-mail, la branche, le fork, la confidentialité, l’exécution Actions, le chemin de sortie et le cache du README. La snake ne peut pas afficher une activité absente du graphe.
Puis-je l’ajouter sans GitHub Actions ?
Oui, un SVG ou GIF peut être commité manuellement, mais il ne se régénérera pas. Utilisez alors une capture datée et expliquée.
La snake est-elle la même chose que GitHub City ?
Non. La snake est une image animée compacte pour README ; GitHub City est une visualisation 3D interactive de l’activité visible.
L’image révèle-t-elle les noms de dépôts privés ?
Elle ne doit pas servir à révéler des informations privées. Vérifiez les réglages de visibilité et le fichier publié avant de le partager.