O que é uma animação snake de contribuições do GitHub?
Uma animação snake de contribuições do GitHub é um recurso visual gerado a partir do gráfico que o GitHub mostra para uma conta. A cobra percorre as células do calendário e produz um SVG ou GIF que pode ser incorporado ao README de perfil. Ela é uma camada de apresentação: não cria contribuições, não corrige atividade ausente e não altera o histórico do repositório.
O repositório Platane/snk documenta saídas em GIF e SVG e uma GitHub Action que recebe o nome do usuário e os caminhos de saída. O workflow pode gravar arquivos como dist/github-snake.svg no repositório usado pelo README. O projeto também descreve uma Action somente para SVG, mais rápida.
Essa diferença ajuda quando a snake parece vazia. Comece pelo gráfico oficial do perfil e confirme se a atividade esperada está visível. O e-mail do commit, a branch, o fork, o repositório, a privacidade e o tempo de processamento podem fazer o histórico e o perfil divergirem. Se a origem estiver incompleta, gerar a animação de novo apenas movimenta dados incompletos.
Para uma imagem fixa, consulte o guia de PNG de contribuições. Para um README de perfil com projetos e links ao redor da animação, veja o guia de README de perfil. A snake tem uma função específica: dar movimento ao calendário em um recurso pequeno e fácil de entender.
Como configurar uma animação snake de contribuições do GitHub
A manutenção fica mais simples quando o arquivo gerado vive em uma pasta previsível e um único workflow faz a atualização. Use a sintaxe oficial como ponto de partida e adapte o caminho ao repositório que publica seu README.
Escolha o repositório que hospedará o arquivo
Um README de perfil normalmente fica no repositório com o mesmo nome do usuário do GitHub. Confirme esse repositório e sua branch padrão antes de criar o workflow.
Adicione um workflow agendado do GitHub Actions
Crie um arquivo em .github/workflows/ e use a Action documentada Platane/snk@v1. Passe o usuário por github_user_name; o contexto do proprietário é conveniente no repositório de perfil.
Escolha SVG, GIF ou os dois
Use svg_out_path para um recurso leve e fácil de incorporar. Inclua gif_out_path somente quando o movimento for útil e o tamanho maior for aceitável.
Faça commit da saída em um caminho estável
Mantenha o arquivo em uma pasta como dist/ e verifique as permissões que permitem à Action atualizá-lo. Um diretório temporário do runner não funciona para o README.
Inclua a URL real no README.md
Referencie o SVG ou GIF por uma URL raw do GitHub ou por um caminho relativo quando os arquivos estiverem juntos. Abra o perfil publicado para confirmar a imagem fora do log do Actions.
Arquivos, saídas e verificações de atualização
Quatro locais têm responsabilidades diferentes. O workflow define quando a Action executa; o arquivo gerado é a saída; README.md é a apresentação pública; e o gráfico oficial confirma a fonte. Separar as camadas facilita encontrar um erro.
Um workflow agendado pode renovar o recurso depois que o GitHub processar novas atividades, mas uma execução bem-sucedida não garante que todo commit local apareça. O GitHub precisa processar o gráfico e a Action não enxerga atividades privadas ou não contabilizadas. A data do arquivo é uma pista de manutenção, não uma medida de produtividade.
Mantenha o README acessível. Coloque uma explicação curta ou um link textual perto da animação e ofereça uma alternativa estática para quem desativa movimento. O visual deve apoiar projetos e documentação, não escondê-los.
| Camada | Função | Verificar antes de compartilhar |
|---|---|---|
| .github/workflows/*.yml | Executar a Action manualmente ou por horário. | Usuário, versão, permissões e gatilho estão explícitos. |
| dist/github-snake.svg | Guardar a animação vetorial gerada. | O arquivo existe na branch usada pelo README. |
| dist/github-snake.gif | Alternativa raster animada opcional. | Tamanho e movimento justificam o uso. |
| README.md | Mostrar o recurso com o contexto do perfil. | A URL raw ou relativa carrega em uma visita nova. |
| Gráfico do perfil | Verificar a fonte lida pela snake. | As contribuições esperadas aparecem após o processamento. |
Snake e outros visuais de contribuições do GitHub
Os formatos podem usar os mesmos dados, mas resolver tarefas diferentes. Escolha o visual mínimo que responda à pergunta do leitor e enlace para regras mais detalhadas quando necessário.
Use snake para movimento no README
É compacta e divertida quando o leitor entende que as células são contribuições. Inclua texto e uma alternativa fixa quando o movimento não for adequado.
Use PNG para uma imagem estável
PNG funciona bem em portfólios, apresentações e documentos. Permite legendar um período específico sem depender da animação.
Use Profile 3D Contrib para uma imagem 3D automática
Um calendário 3D gerado por workflow serve para uma imagem mais rica no repositório de perfil. A configuração é diferente da snake.
Use GitHub City para explorar em 3D
GitHub City transforma atividade visível em uma cena urbana interativa no navegador. É outra camada visual, não substituto do workflow do README.
Por que a snake do GitHub fica vazia ou antiga
Uma snake vazia costuma apontar para o gráfico de origem, a saída do workflow ou a URL do README. Verifique essas três camadas nessa ordem. Abra o perfil público, depois o log da execução do Actions e, por fim, a URL direta do arquivo commitado em vez de confiar em uma página em cache.
Se o gráfico não mostra a atividade, confira o e-mail do commit, a branch, o repositório ou fork, a visibilidade das contribuições privadas e o atraso do GitHub. O histórico do repositório e o gráfico do perfil respondem perguntas diferentes; um commit pode existir em um e ainda aguardar no outro.
Se o gráfico estiver correto, mas o arquivo antigo, revise o gatilho, o agendamento, o log da Action, o caminho de saída e a branch usada pelo README. Se o arquivo existe e uma imagem velha continua aparecendo, verifique a URL raw, nomes duplicados e o cache antes de mudar o workflow novamente.
Ordem para depurar
Gráfico do perfil, log do Actions, saída commitada e embed do README. Corrigir a URL de apresentação antes de verificar os dados pode esconder a causa.
FAQ da animação snake de contribuições do GitHub
O que é uma animação snake de contribuições do GitHub?
É um SVG ou GIF gerado a partir do gráfico de contribuições visível de um usuário. A cobra percorre as células e pode ser colocada no README de perfil; ela não cria contribuições.
Qual repositório deve conter a imagem?
Para um README de perfil, use o repositório com o mesmo nome do usuário no GitHub. Salve o arquivo em uma pasta estável da branch referenciada pelo README.
É melhor usar SVG ou GIF?
SVG geralmente é a opção mais leve para um README. GIF adiciona movimento, mas exige verificar tamanho, carregamento e a necessidade de uma alternativa estática.
Com que frequência a snake atualiza?
Quando o workflow executa e o gráfico está disponível para a Action. O agendamento e o processamento do GitHub definem quando a nova atividade aparece.
Por que meus commits recentes não aparecem?
Confira primeiro o gráfico oficial, depois e-mail, branch, fork, privacidade, execução do Actions, caminho de saída e cache do README. A snake não consegue mostrar atividade que não está no gráfico.
Posso colocar a snake sem GitHub Actions?
Você pode fazer commit de um SVG ou GIF manualmente, mas ele não será atualizado sozinho. Trate-o como uma captura datada e explique o período.
A snake é igual ao GitHub City?
Não. A snake é um recurso animado compacto para README; GitHub City é uma visualização 3D interativa da atividade visível no navegador.
A imagem revela nomes de repositórios privados?
Ela não deve ser usada para revelar detalhes privados. Verifique as configurações do perfil e o arquivo publicado antes de compartilhá-lo.