SNK

SNK recria o jogo da cobrinha diretamente no gráfico de contribuições do GitHub.

Uso

1. No seu repositório, crie o diretório .github/workflows/.
2. Adicione o arquivo snk.yml com o seguinte conteúdo:

name: generate animation

on:
  # Executa automaticamente a cada 24hrs
  schedule:
    - cron: "0 */24 * * *"

  # Permite execução manual
  workflow_dispatch:

  # Executa toda ver que tem um push na branch master
  push:
    branches:
    - master

jobs:
  generate:
    permissions:
      contents: write
    runs-on: ubuntu-latest
    timeout-minutes: 5

    steps:
      # Cria o jogo da cobrinha no gráfico de contribuições (<github_user_name>) do usuário, a saída é uma animação SVG em <svg_out_path>
      - name: generate github-contribution-grid-snake.svg
        uses: Platane/snk/svg-only@v3
        with:
          github_user_name: ${{ github.repository_owner }}
          outputs: |
            dist/github-contribution-grid-snake.svg
            dist/github-contribution-grid-snake-dark.svg?palette=github-dark

      # Envia o conteúdo <build_dir> para o branch
      # O conteúdo ficará disponível em https://raw.githubusercontent.com/<github_user>/<repository>/<target_branch>/<file> , ou na página do GitHub
      - name: push github-contribution-grid-snake.svg to the output branch
        uses: crazy-max/ghaction-github-pages@v3.1.0
        with:
          target_branch: output
          build_dir: dist
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

3. No seu repositório, crie ou edite um arquivo README.md e inclua:

<picture>
  <source media="(esquema-de-cores: dark)" srcset="https://raw.githubusercontent.com/[Owner]/[Repo]/output/github-contribution-grid-snake-dark.svg">
  <source media="(esquema-de-cores: light)" srcset="https://raw.githubusercontent.com/[Owner]/[Repo]/output/github-contribution-grid-snake.svg">
  <img alt="github contribution grid snake animation" src="https://raw.githubusercontent.com/[Owner]/[Repo]/output/github-contribution-grid-snake.svg">
</picture>

Parâmetros

Clique para exibir/fechar os parâmetros

Nome	Tipo	Obrigatório	Padrão	Descrição	Mais Observações
github_user_name	string	true		Nome do usuário no GitHub
github_token	string			Token do GitHub
outputs	array			Lista de arquivos gerados	A regra de saída é como descrito em outputs.

Exemplos

<!-- platane -->
<picture>
  <source media="(esquema-de-cores: escuro)" srcset="https://raw.githubusercontent.com/platane/platane/output/github-contribution-grid-snake-dark.svg">
  <source media="(esquema-de-cores: claro)" srcset="https://raw.githubusercontent.com/platane/platane/output/github-contribution-grid-snake.svg">
  <img alt="github contribution grid snake animation" src="https://raw.githubusercontent.com/platane/platane/output/github-contribution-grid-snake.svg">
</picture>