technology

Como gerar automaticamente mensagens de confirmação para o GitHub usando aicommits

.

Às vezes, você pode se sentir sobrecarregado ou sem inspiração para escrever mensagens de confirmação para as alterações feitas em uma base de código, mas não mais, graças ao aicommits!

Todos nós sabemos a importância das convenções de mensagem de commit, mas escrever uma mensagem significativa para cada mudança pode ser um processo tedioso e demorado, e é por isso que ferramentas como aicommits estão se tornando cada vez mais populares.

aicommit é uma nova ferramenta que usa a API OpenAI para examinar seu código e criar automaticamente uma mensagem de confirmação concisa e relevante sobre as alterações feitas no código.

Então, vamos ver como você pode instalar aicommits em seu computador para escrever uma mensagem de commit significativa em nenhum momento.

Instalar aicommits

Para isso, primeiro você precisa ter o NodeJS v14 ou posterior e o gerenciador de pacotes npm instalado em sua máquina. Se já estiver lá, você pode pular esta etapa e prosseguir para a Etapa 2 deste artigo para instalar o “aicommits” do gerenciador de pacotes npm.

Etapa 1: instalar o NodeJS e o npm

NodeJS e npm podem ser facilmente encontrados no repositório oficial do Ubuntu ou Debian, mas o ponto é que você encontrará a versão mais antiga do NodeJS, que não funcionará com esta ferramenta, portanto, para obter a versão necessária do NodeJS, execute o seguinte comando:

$ curl -fsSL https://deb.nodesource.com/setup_14.x | sudo -E bash -
$ sudo apt install -y nodejs

Depois que a instalação estiver concluída, você poderá testar a presença do nodejs v14.xe a versão mais recente do npm executando a próxima linha de comando em seu terminal.

$ node -v && npm --version 

Etapa 2: instalar o aicommits

Depois de confirmar nodejs e npm, vamos executar outro comando para instalar a ferramenta aicommit, que irá sugerir mensagens de commit para suas mudanças no código automaticamente quando você executar “aicommit”.

$ sudo npm install -g aicommits

Etapa 3: obtenha a chave da API OpenAI

Para isso, você precisa acessar https://platform.openai.com/account/api-keys para obter a chave da API. Se você já possui uma conta no OpenAI, pode usá-la ou criar uma nova.

Depois de obter a chave da API, execute o seguinte comando, substituindo pela chave do token, para salvá-la no ~/.aicommits arquivo.

$ echo "OPENAI_KEY=<your_token>" >> ~/.aicommits

Observação: a OpenAI API é um serviço pago, mas você receberá US$ 18 em crédito gratuito, que poderá usar para testar esse recurso.

Gere uma mensagem de confirmação automática para alterações.

Vamos dar uma olhada em como você pode gerar uma mensagem de commit com base nas alterações no diretório do projeto ou em qualquer arquivo e, para isso, você precisa ter um projeto inicializado com um repositório Git.

Para mostrar como funciona, deixe-me demonstrá-lo fazendo alterações em um arquivo de amostra no repositório, fazendo algumas alterações no arquivo de origem “src/commands/aicommits.ts”.

Quando você invoca o aicommits comando, ele verificará as alterações que você fez no respectivo arquivo e, após a análise, emitirá uma mensagem de commit.

Se a mensagem estiver de acordo com sua expectativa, escolha “Sim” para confirmar as alterações com sucesso e, se não gostar, escolha “Não” para descartar a mensagem de confirmação.

E aqui está o resultado das mudanças.

Uma mensagem de confirmação é sugerida pela ferramenta aicommit

Se você está se perguntando como isso funciona, deixe-me dizer que basicamente usa o git diff comando para comparar as versões anteriores e posteriores do arquivo e enviá-los para o OpenAI GTP-3 para gerar uma mensagem de confirmação que melhor descreva suas alterações.

Embrulhar

Depois de usá-lo por algumas horas, sim, é interessante usá-lo quando você deseja que a IA escreva mensagens de commit para você, mas existem algumas limitações, que já estão na lista de tarefas do desenvolvedor para o projeto.

Como este projeto está em desenvolvimento, você encontrará muitos novos recursos nos próximos dias, como quando você não preferir usar a mensagem sugerida, poderá digitar sua própria mensagem, adicionar suporte para diferenças maiores que 200 linhas, e muito mais, então fique ligado no aicommit para obter as atualizações mais recentes.

Portanto, fique atento ao aicommit para obter as atualizações mais recentes e certifique-se de iniciar o projeto no GitHub.

Antes de encerrar este artigo, gostaria de compartilhar 3 passes gratuitos e 50% de desconto na inscrição, que será por ordem de chegada, para a Southern California Linux Expo (SCaLE 20x), que será realizada em Pasadena, CA, de 9 a 12 de março de 2023.

Os principais palestrantes deste ano são:
– Ken Thompson (Criador do Go e Unix)
– Kitty Yeung (Física e Artista)
– Arun Gupta (Intel e CNCF)

Confira aqui a lista completa de expositores, veja https://socallinuxexpo.org/scale/20x/exhibitors

Se você estiver interessado em um passe livre e desconto na inscrição, entre em contato comigo em [email protected]


.

Mostrar mais

Artigos relacionados

Deixe um comentário

O seu endereço de e-mail não será publicado. Campos obrigatórios são marcados com *

Botão Voltar ao topo