Como adicionar o Snake Game no seu README do Github 🐍

#github #tutorial

[Atualizado 2023]

Passo 1: Criando o Repositório

A primeira coisa que você deve fazer é criar um repositório público no seu GitHub com o nome do seu usuário. O GitHub vai entender que esse repositório possui um README especial de personalização e vai adicionar todas as alterações no seu overview.

Passo 2: Configurando seu GitHub actions

Antes de criar o seu workflow e adicionar o script, é importante que você ative algumas permissões que possivelmente estão desmarcadas no seu perfil.
Para alterar o que é necessário, entre no repositório que você criou e clique em settings > actions > general e ative as seguintes opções:

🔘 allow all actions and reusable workflows

🔘 read and write permissions

Passo 3: Criando o seu workflow

Agora que temos todas as permissões ativadas, vamos adicionar o script para gerar os arquivos necessários.
No seu repositório, clique em actions > new workflow e por fim clique em configurar simple workflow.

Quando você clicar vai abrir uma caixa de código, e é lá que vamos adicionar o nosso script! Apague todo o conteúdo predefinido e cole somente este:

name: Generate Datas

on:
  schedule: # execute every 12 hours
    - cron: "* */12 * * *"
  workflow_dispatch:

jobs:
  build:
    name: Jobs to update datas
    runs-on: ubuntu-latest
    steps:
      # Snake Animation
      - uses: Platane/snk@master
        id: snake-gif
        with:
          github_user_name: username #seu username
          svg_out_path: dist/github-contribution-grid-snake.svg

      - uses: crazy-max/ghaction-github-pages@v2.1.3
        with:
          target_branch: output
          build_dir: dist
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Em #seu username coloque o seu nome de usuário no GitHub

Após todo esse processo, altere o nome do documento e clique em start commit. Seu workflow já está pronto para uso! Para dar start no processo, basta ir em actions > generate datas > run workflow.