O Ritchie CLI é uma ferramenta open source da Zup muito versátil! No tutorial de hoje vamos ver como customizar um perfil no Github com o Ritchie!
Introdução
Já faz algum tempo que existe a possibilidade de customizar nossa conta Github criando um repositório com nosso nome de usuário.
Inclusive, existem vários tutoriais na internet explicando como fazer isso manualmente, como por exemplo, esse do Natanael de Sousa Leite.
Hoje, vou trazer para vocês um passo a passo para criar e personalizar este perfil, automatizando o processo através do Ritchie CLI, para obter um resultado parecido com o seguinte:
Premissas:
Python 3 deve ser instalado no computador (é nativo no sistema operacional Unix).
Etapa 1 – Instalação do Ritchie
O Ritchie é um CLI que permite ao usuário criar, armazenar e compartilhar qualquer tipo de automação (chamadas fórmulas), executando-as através de linhas de comando.
Um deles nos fornecerá o arquivo README.md que usaremos em nossa conta do Github.
Para instalar o Ritchie:
Unix (no terminal)
curl -fsSL https://commons-repo.ritchiecli.io/install.sh | bash
Windows (baixe o .msi)
https://commons-repo.ritchiecli.io/latest/ritchiecli.msi
Etapa 2 – Inicialização
Execute o seguinte comando para inicializar o Ritchie:
rit init
Este comando fará 3 perguntas:
- Se você deseja contribuir anonimamente para as métricas da Ritchie.
- Se você deseja adicionar as fórmulas da comunidade localmente.
- Se você quiser que o método de execução da fórmula padrão seja local ou por meio do docker. (Aqui, escolha LOCAL).
Etapa 3 – Adicionar um repositório de fórmulas Ritchie
Para criar o README.md para nosso perfil, precisamos importar o repositório que contém a fórmula que planejamos usar. Você encontra essas informações aqui.
Para isso, execute o comando abaixo:
rit add repo --provider="Github" --name="formulas-github" --repoUrl="https://github.com/GuillaumeFalourd/formulas-github" --priority=1Etapa 4 – Crie o perfil Github
rit add repo –p
Etapa 4.1 – Criar o repositório Github
Etapa 4.1.1 – Com Ritchie
Crie um token Github seguindo essa documentação.
Em seguida, execute o seguinte comando:
rit github create repo
O repositório será criado no diretório onde você executou o comando acima.
Etapa 4.1.2 – Ou, com a interface do Github
Crie o repositório com seu nome de usuário Github aqui: https://github.com/new
Em seguida, clone o repositório Github em seu computador.
Etapa 4.2 – Criar o arquivo README customizado
No terminal, acesse o repositório que você acabou de criar:
cd <MyUsername>
Em seguida, execute o seguinte comando:
rit github create profile
Este comando irá sobrescrever o arquivo README.md atual de acordo com os dados que você informar.
Etapa 4.3 – Suba seu código
git add .
git commit -m "first commit"
git push origin main
Conclusão
Pronto! Seu perfil agora está online em sua conta Github.
Podemos melhorar esta fórmula para adicionar outros recursos ao arquivo README.md.
Agora você pode fazer isso manualmente no arquivo que foi gerado ou contribuir com o repositório para melhorar o modelo e adicionar mais opções. Segue novamente o repositório com as fórmulas.
E abaixo você pode encontrar ao modelo que foi seguido na implementação inicial da fórmula em Python, usando a biblioteca MdUtils, que é bem prática para manipular arquivos Markdown:
Até a próxima!
Quer ver esse tutorial em vídeo? Então confira:
