Como criar uma tap de homebrew no GitHub

Editado 1 dia atrás por ExtremeHow Equipe Editorial

HomebrewGitHubTorneiras PersonalizadasDesenvolvimento de SoftwareCódigo AbertoTerminalLinha de comandoGerenciamento de PacotesProgramaçãoColaboração

Homebrew é um gerenciador de pacotes popular para macOS (e Linux) que ajuda os usuários a instalar facilmente softwares que a Apple ou o sistema não fornecem por padrão. Ele funciona gerenciando a instalação de pacotes de software e suas dependências. A "Tap" é um repositório adicional para fórmulas do Homebrew. Essas fórmulas são scripts que descrevem como instalar um pacote específico. Criar uma tap de Homebrew no GitHub permite distribuir facilmente seu software para os usuários. Aqui, vamos passar pelos passos detalhados para criar sua própria tap de Homebrew no GitHub.

Pré-requisitos

Existem alguns pré-requisitos antes de construir uma tap de homebrew:

• Conta no GitHub: você precisará de uma conta no GitHub para hospedar sua tap.
• Homebrew instalado no seu sistema: Este guia assume que você já tem o Homebrew instalado e configurado no seu computador. Se não, visite o site do Homebrew para instalá-lo.
• Conhecimento básico de Git e GitHub: você deve estar familiarizado com repositórios, clonagem e comandos básicos do git.

Passo 1: Criar um repositório no GitHub

O primeiro passo é criar um novo repositório no GitHub. Este repositório servirá como lar para suas fórmulas. Siga estes passos:

1. Faça login na sua conta do GitHub e vá para a página Repositories.
2. Clique no botão “New” para criar um novo repositório.
3. Nomeie seu repositório neste formato: homebrew-<nome>. Por exemplo, se você está criando uma tap para um projeto chamado "ferramenta-incrível", você poderia nomear o repositório homebrew-ferramenta-incrível.
4. Adicione uma descrição para seu repositório (opcional, mas recomendado).
5. Não inicialize o repositório com um README, .gitignore, ou licença, pois esses serão adicionados mais tarde.
6. Clique no botão "Create Repository".

Passo 2: Clonar o repositório localmente

Uma vez que seu repositório é criado, você precisa cloná-lo para sua máquina local para começar a adicionar arquivos de fórmula. Aqui está como fazer:

1. Copie a URL do repositório do GitHub. Esta URL pode ser obtida clicando no botão "Code" em seu repositório recém-criado.
2. Abra seu terminal.
3. Use o comando git clone para clonar o repositório para sua máquina local:

git clone https://github.com/<username>/homebrew-<name>.git

4. Navegue para o diretório do repositório clonado:

cd homebrew -p <name>

Passo 3: Criar o arquivo de fórmula

Agora é hora de criar um arquivo de fórmula. Este arquivo contém todas as informações sobre como o Homebrew deve instalar seu software. Siga estes passos:

1. Na raiz do seu repositório local, crie um novo diretório chamado Formula. É aqui que todos os seus arquivos de fórmula estarão:

The mkdir formula

2. Navegue para o diretório Formula:

CD Formula

3. Crie um novo arquivo Ruby para sua fórmula. O nome do arquivo deve ser o nome do seu software com a extensão .rb. Por exemplo, crie ferramenta-incrível.rb para "ferramenta-incrível":

touch ferramenta-incrível.rb

Passo 4: Escrever a fórmula

Em seguida, edite o arquivo de fórmula e adicione o código Ruby necessário para determinar como instalar seu software. Aqui está um exemplo simples do que poderia estar dentro de ferramenta-incrível.rb:

class FerramentaIncrível < Fórmula
    Descrição "Ferramenta incrível é uma grande utilidade para coisas incríveis"
    Página inicial "https://exemplo.com/ferramenta-incrível"
    URL "https://exemplo.com/ferramenta-incrível-v1.0.tar.gz"
    sha256 "valor de checksum de exemplo aqui 1234567890abcdef"
    Versão "1.0"

    def install
        bin.install "Ferramenta Incrível"
    Ending
Ending

Explicação do código:

• class FerramentaIncrível < Formula : Esta linha define a classe da fórmula e herda da classe Formula do Homebrew.
• desc : Uma descrição curta do seu software.
• homepage : A URL da página inicial do software.
• url : A URL da qual o código fonte ou o binário do software pode ser baixado.
• sha256 : O checksum SHA256 do arquivo baixado da URL. Isso verifica a integridade do arquivo.
• version: A versão do software.
• def install : Este método define como instalar o software. bin.install copia os executáveis para um diretório gerenciado pelo Homebrew.

Passo 5: Cometer e enviar suas mudanças

1. Após escrever a fórmula, salve o arquivo.
2. Volte para a raiz do seu repositório:

CD..

3. Use os seguintes comandos do git para preparar, cometer e enviar suas mudanças para o GitHub:

git add .
git commit -m "Adicionar fórmula da ferramenta incrível"
git push origin main

Passo 6: Teste sua tap

Antes de compartilhar sua tap com os outros, é importante testá-la para garantir que ela funcione como esperado:

1. Para usar sua tap, primeiro adicione-a ao Homebrew com o seguinte comando:

brew tap <username>/<name>

2. Instale seu software usando o comando brew install:

brew install ferramenta-incrível

3. Verifique se o software está instalado e funcionando como esperado.

Passo 7: Mantenha sua tap

Uma vez que sua tap esteja implantada, é importante mantê-la. Isso inclui atualizar fórmulas com novas versões do software e manter um olho em quaisquer problemas que os usuários encontrem. Aqui estão algumas dicas:

• Quando uma nova versão do seu software for lançada, atualize version, url e sha256 no seu arquivo de fórmula.
• Use o fluxo de trabalho do git para comprometer e enviar atualizações para sua tap.
• Responda a quaisquer problemas ou pull requests enviados ao seu repositório.

Dicas adicionais

Aqui estão algumas dicas adicionais e melhores práticas a serem lembradas ao construir e manter uma tap de homebrew:

• Escreva fórmulas claras e simples. Certifique-se de que cada fórmula seja fácil de ler e entender.
• Use mensagens de commit significativas para documentar mudanças.
• Sempre que possível, certifique-se de que suas fórmulas tenham casos de teste significativos.
• Engaje-se com a comunidade discutindo problemas e aceitando contribuições.
• Verifique a documentação do Homebrew regularmente para atualizações sobre quaisquer melhores práticas ou mudanças.

Criar uma tap de Homebrew no GitHub é uma ótima maneira de distribuir seu software para um público amplo com o mínimo de complicação. Seguindo os passos descritos neste guia, você pode configurar uma tap e permitir que os usuários instalem facilmente seu software através do Homebrew. Seja para uso pessoal ou distribuição em massa, alavancar uma tap de Homebrew pode simplificar a instalação de software em macOS e Linux.

  Compartilhe Este Artigo

Se você encontrar algo errado com o conteúdo do artigo, você pode solicitar uma atualização