O controle de versão é uma instrumento vital para rastrear alterações em sua base de código, mas você nem sempre deseja rastrear todos os arquivos.
Para evitar confusão e reduzir o risco de distribuição de informações confidenciais, você pode usar um registro chamado .gitignore. Leste registro especifica quais arquivos e diretórios o Git não deve indexar.
Ordenar quais arquivos incluir em .gitignore pode ser um duelo, principalmente se você for novo no desenvolvimento. Descubra quais arquivos você deve juntar ao seu .gitignore para um fluxo de trabalho do Git mais suave.
Criando um registro .gitignore
Para que seu registro .gitignore tenha qualquer efeito, você deve ter o Git inicializado em seu projeto.
Você pode inicializar o Git executando o comando aquém no seu terminal:
git init
Leste comando cria um novo repositório Git para o seu projeto, em um subdiretório “.git” oculto que contém todos os arquivos e diretórios necessários para controlar a versão do seu projeto.
Em seguida, crie seu registro .gitignore executando o comando aquém:
touch .gitignore
A realização do comando supra cria um novo registro, “.gitignore” em seu diretório atual. Você pode excluir um registro do Git adicionando o nome do registro ou o caminho do registro (se o registro estiver em um diretório dissemelhante do .gitignore registro).
O Git não precisa rastrear todos os arquivos do seu projeto, e rastrear alguns arquivos pode levar a problemas imprevistos. Estes são alguns dos arquivos que você deve juntar ao seu .gitignore.
1. Arquivos de feição
Os arquivos de feição armazenam configurações e outros parâmetros que seus aplicativos usam para definir e personalizar seu comportamento. Esses arquivos geralmente armazenam strings de conexão de banco de dados, chaves de API e outras informações confidenciais que você não deve expor em seu repositório Git.
Se você incluir arquivos de feição em seu repositório, qualquer pessoa que possa acessá-lo poderá visualizar seu teor. Isso pode incluir informações confidenciais, que podem levar a violações de segurança e outros problemas.
Para excluir arquivos de feição do seu repositório Git, adicione nomes de arquivos específicos ou nomes de pastas ao seu .gitignore registro.
Por exemplo, você pode juntar a risco aquém ao seu .gitignore registro para ignorar um .env registro.
.env
2. Crie Artefatos
Artefatos de construção são os arquivos compilados ou gerados produzidos quando você constrói seu projeto. Esses arquivos geralmente ficam em um “intuito” ou “edificar” diretório.
Os artefatos de construção podem incluir classes Java compiladas, arquivos JAR, arquivos WAR, arquivos binários, pacotes de distribuição, relatórios, arquivos de log e outros gerados durante o processo de construção.
Geralmente, é uma boa prática excluir artefatos de construção do seu repositório Git porque eles podem ser muito grandes. Eles também podem ser menos portáteis do que seus arquivos de origem, relevantes somente para um envolvente específico. Incluí-los em seu repositório pode aumentar o tamanho de seu repositório e torná-lo mais lento para clonar e trabalhar.
Para excluir artefatos de construção de seu repositório Git, adicione o “intuito/” ou “edificar/” diretório para o seu .gitignore registro.
Por exemplo:
target/
build/
3. Arquivos do Envolvente de Desenvolvimento Integrado
Os arquivos do envolvente de desenvolvimento integrado (IDE) são arquivos de feição, metadados de projeto e outros arquivos gerados pelo seu IDE quando você cria ou abre um projeto. Esses arquivos são específicos para cada IDE. Seu IDE usa esses arquivos para definir as configurações do projeto.
Esses arquivos são desnecessários para compilar ou executar seu aplicativo e geralmente podem suscitar problemas se forem enviados para um repositório Git compartilhado. Por exemplo, pessoas diferentes em sua equipe podem usar IDEs ou versões diferentes, e a confirmação de arquivos específicos de IDE pode suscitar conflitos de mesclagem e dificultar a colaboração no projeto.
Porquê esses arquivos são específicos do IDE, os arquivos a serem incluídos em seu .gitignore registro vai depender do seu IDE. Cá estão as recomendações .gitignore do GitHub para alguns IDEs populares. Você pode procurar o IDE de sua escolha e juntar os arquivos descritos ao seu .gitignore registro.
4. Sujeição e Arquivos de Pacote
Arquivos de sujeição e pacote são arquivos que contêm informações sobre as dependências e pacotes usados por seu aplicativo. Várias ferramentas de compilação, porquê o Node Package Manager (npm), geram esses arquivos.
Por exemplo, se você usar o npm para gerenciar dependências para um projeto JavaScript, ele criará um “node_modules” pasta no diretório raiz do seu projeto. O diretório contém todas as dependências instaladas para o seu projeto.
Leste diretório pode se tornar muito grande, principalmente se seu projeto tiver muitas dependências ou algumas dependências tiverem tamanhos de registro grandes. Ao excluir o “node_modules” do seu repositório Git, você pode mantê-la limpa e reduzir seu tamanho.
Para evitar juntar o “node_modules” ao seu repositório Git, adicione seu nome ao seu registro .gitignore:
node_modules/
5. Arquivos do sistema operacional
Seu sistema operacional e outras ferramentas do sistema podem gerar arquivos por meio do uso normal. Isso pode incluir arquivos de log, arquivos temporários e arquivos de feição do sistema. Um exemplo é o Thumbs.db registro no Windows e seu equivalente macOS, o .DS_Store registro.
Geralmente, é uma boa prática excluir arquivos do sistema operacional de seu repositório Git, pois eles são específicos para seu envolvente lugar e podem divergir entre diferentes computadores e sistemas operacionais.
O GitHub recomendou diretrizes de .gitignore para Windows, macOS e Linux.
A prestígio do controle de versão
Usar o controle de versão pode melhorar significativamente seu fluxo de trabalho e reduzir erros e conflitos que podem surgir ao trabalhar em uma base de código. Com o controle de versão, você pode escoltar facilmente as alterações de código, revisá-las e colaborar com os membros da equipe de forma integrada.
No entanto, você sempre deve excluir determinados arquivos, porquê arquivos de feição, arquivos IDE e arquivos do sistema operacional. Isso manterá o tamanho do seu repositório grave e garantirá que você não vaze informações confidenciais.
