Gerador de .gitignore

Selecione todas as tecnologias utilizadas neste repositório.

As regras do sistema operacional e do editor geralmente ficam no arquivo global de exclusões do Git.

Próximo: revisar regras

Selecione as tecnologias usadas no repositório para criar um .gitignore do projeto que exclui arquivos gerados, dependências e arquivos de ambiente locais. Você pode escolher várias tecnologias. As regras do sistema operacional e do editor aparecem separadamente, para que as preferências pessoais fiquem no arquivo global de exclusões do Git.

Como criar e usar as regras de exclusão

  1. 1

    Selecione as tecnologias do projeto

    Escolha todas as tecnologias do repositório, como Laravel e Node.js para um aplicativo PHP com build do frontend.

  2. 2

    Adicione regras pessoais se precisar

    Selecione o sistema operacional ou o editor para ver um conjunto separado de exclusões globais. Se o seu arquivo global já incluir essas regras, deixe as opções em branco.

  3. 3

    Revise, copie ou baixe

    Confira as regras do projeto. Copie-as para um `.gitignore` na raiz do repositório ou baixe o ZIP e extraia o `.gitignore` nele contido para essa pasta. Coloque as regras pessoais opcionais no arquivo global de exclusões do Git.

  4. 4

    Confira antes de fazer o commit

    Faça o commit do `.gitignore` do projeto para compartilhar as regras com a equipe. Confirme que os arquivos necessários, principalmente exemplos de configuração e arquivos de bloqueio de dependências, continuam visíveis para o Git.

Quais regras devem ficar em cada arquivo?

Tipo de regra Onde colocar Exemplo
Arquivos gerados pelo projeto e dependências instaladas Um .gitignore registrado no repositório node_modules/, vendor/, __pycache__/
Valores de ambiente locais O .gitignore do projeto .env e variantes locais de .env.*
Arquivos do seu sistema operacional e editor Um arquivo global de exclusões do Git ou .git/info/exclude para um único repositório Metadados do Finder ou backups do editor
Arquivos de que a equipe precisa Mantê-los no controle de versão quando apropriado .env.example, package-lock.json, composer.lock, Gemfile.lock

O Git consulta os arquivos .gitignore do projeto, o .git/info/exclude específico do repositório e o arquivo pessoal definido em core.excludesFile. Ao fazer o commit de .gitignore, você compartilha as regras do projeto com o repositório. Uma regra pessoal geralmente se aplica apenas ao seu computador. Consulte o manual do Git sobre gitignore e o guia do GitHub sobre como ignorar arquivos.

Exemplo: um serviço Node.js com scripts Python

Selecione Node.js e Python. O arquivo do projeto combina regras para pacotes instalados, como node_modules/, resultados do build do Node, como dist/, e arquivos gerados pelo Python, como __pycache__/ e .venv/. Ele também exclui os valores locais em .env, mas permite manter .env.example no controle de versão. Se você usa um Mac e o Visual Studio Code, selecione essas opções pessoais para examinar as regras separadamente. Compare os dois resultados com o repositório antes de salvá-los.

O gerador usa os modelos selecionados. Ele não consegue examinar seus arquivos nem saber se uma pasta chamada dist/ contém resultados gerados ou código-fonte que você deseja incluir no repositório. Ajuste ou remova uma regra que não se aplica ao projeto. Use git check-ignore -v path/to/file para identificar a regra aplicada a um arquivo ainda não rastreado. A coleção de modelos do GitHub ajuda a consultar convenções para tecnologias e editores, mas não substitui a revisão do seu repositório.

Arquivos de ambiente e de bloqueio

Excluir .env ajuda a evitar que credenciais locais entrem em novos commits, mas não apaga um segredo já registrado no Git. Se ele estiver no histórico, deixe de rastrear o arquivo, verifique onde foram feitas cópias e troque a credencial. Mantenha .env.example no controle de versão somente se ele contiver valores fictícios, sem segredos reais. O arquivo gerado já inclui !.env.example para que a regra ampla .env.* não oculte o exemplo. Preserve essa exceção se editar as regras.

Em aplicativos, mantenha os arquivos de bloqueio para que as instalações reproduzam as versões escolhidas. O npm recomenda fazer o commit de package-lock.json e o Composer recomenda fazer o commit de composer.lock. Bibliotecas podem seguir convenções diferentes; siga as políticas de build e lançamento de cada projeto.

Perguntas frequentes

As regras de exclusão afetam arquivos que o Git ainda não rastreia. Para parar de rastrear um arquivo sem apagar a cópia local, execute git rm --cached path/to/file e faça o commit dessa remoção. Se o arquivo continha uma credencial, troque-a e confira o histórico do repositório e todas as cópias.

Em geral, mantenha um .env.example sem segredos e os arquivos de bloqueio de aplicativos no Git. O exemplo documenta as variáveis de ambiente necessárias; o arquivo de bloqueio fixa as versões das dependências para a equipe e as implantações. Confirme que o exemplo não contém segredos reais.

Sim. Selecione todas as tecnologias usadas no mesmo repositório. O gerador reúne as regras do projeto em um único .gitignore. Confira se algum caminho é usado de outra forma no seu projeto.

Use um arquivo global de exclusões do Git para regras pessoais que valem em vários repositórios. Se XDG_CONFIG_HOME não estiver definido, o Git usa ~/.config/git/ignore por padrão; você pode indicar outro caminho com core.excludesFile. Para uma regra privada apenas neste repositório, use .git/info/exclude. Só adicione as regras pessoais ao arquivo compartilhado do projeto se a equipe quiser usá-las.

As tecnologias selecionadas e as opções de sistema ou editor, se escolhidas, são enviadas ao servidor para criar as regras. No fluxo de várias etapas, essas escolhas também aparecem na URL da página. Não coloque segredos na URL. A ferramenta gera regras com base nas escolhas; ela não lê o repositório nem faz upload dos arquivos.

Ferramentas relacionadas

Ferramenta disponível em outros idiomas