Marque o arquivo como "incompatível" com o Git

Quero mostrar alguns dos meus trabalhos, enviando-os para minha conta do GitHub. No entanto, existem alguns arquivos que contêm senhas, como conexões com o banco de dados.

Existe uma maneira de marcar um arquivo como incompatível com o Git para que ele não possa aparecer no GitHub?

Existe uma maneira de marcar um arquivo como incompatível com o Git para que ele não possa aparecer no GitHub?

Primeiro, não há como ter alguns arquivos e confirmações visíveis no seu repositório Git local, mas de alguma forma não visível no GitHub; se você tiver um arquivo confirmado no Git, ele aparecerá no GitHub.

Segundo, não existe uma maneira simples e prática de marcar um arquivo individual como "inconstante". Mas há definitivamente uma maneira de ignorar um arquivo em um repositório Git: adicionando o (s) arquivo (s) - incluindo seu caminho relativo, se necessário - para um .gitignorearquivo :

Um .gitignorearquivo especifica arquivos não rastreados intencionalmente que o Git deve ignorar. Arquivos já rastreados pelo Git não são afetados; veja as NOTAS abaixo para detalhes.

Criar um básico .gitignoreé bastante fácil, pois é apenas um arquivo de texto simples. Então, por exemplo, se eu tivesse um config.phparquivo na sua raiz, você faria isso; supondo que você esteja usando PHP, mas o conceito se aplica a qualquer configuração. Também estou usando o Nano como meu editor de texto neste exemplo, mas fique à vontade para usar o editor de texto que você normalmente usa para isso:

nano .gitignore

E basta adicionar esse nome de arquivo ao arquivo:

config.php

Salve-o e agora o Git simplesmente ignorará esse arquivo.

Dito isto, o que eu gosto de fazer em configurações como essa é manter uma configuração de exemplo / exemplo neutralizada de detalhes sensíveis no repositório, para que eu tenha alguma referência sobre o formato do arquivo de configuração como um arquivo chamado algo como isto:

config.SAMPLE.php

Dessa forma, você sabe exatamente como o config.phparquivo deve ser configurado config.SAMPLE.phpe você pode garantir que o atual config.phpnunca seja tocado pelo Git.

Além disso, se você planeja exibir seu código, precisa esperar que alguém tente pegar esse código e implementá-lo em seu próprio sistema de alguma forma. Lembre-se de que não somos você e, sem um exemplo de arquivo de configuração no seu repositório, as pessoas realmente não entenderão como implementar o código por conta própria. Caramba, eles podem até achar que você não é competente porque não forneceu um exemplo básico de configuração.

Você também pode adicionar um gancho de pré-confirmação para implementar verificações de sanidade. O diretório .git/hooksde todo repositório git possui alguns scripts de amostra.

O script chamado pre-commité executado se existir antes de cada confirmação e um valor de retorno diferente de zero anula a confirmação.

Por exemplo, você pode ter um script simples como este:

#! /bin/sh -e
git ls-files --cached | grep -qx 'filename' && { echo "Excluded file included in the commit" >&2; exit 1; }
exit 0

E se isso filenamecorresponder, a confirmação falhará.

O que @JakeGould disse. Em alguns casos, você também pode usar bits de arquivo especiais como skip-worktreeou assume-unchangedque podem ser configurados da seguinte maneira; para as diferenças entre os dois, consulte esta resposta de estouro de pilha :

git update-index --assume-unchanged <file>

O que ocultará alterações adicionais em um arquivo já existente e que você poderá usar se realmente desejar que um arquivo esteja lá após cada solicitação. Mas eu aconselho você a usá-lo apenas se realmente souber o que está fazendo.

Use um .gitignorecomo @JakeGould disse. Além disso, algumas informações relacionadas:

• .gitignoreimpede que os arquivos sejam rastreados; se eles já estiverem rastreados, use-os git rm --cachedpara removê-los
• arquivos / padrões $GIT_DIR/info/excludetambém serão ignorados
• arquivos / padrões no arquivo especificado por core.excludesFile no usuário ~/.gitconfigtambém são ignorados.

Veja a documentação oficial do Git para mais detalhes.

Para estender as respostas de Jake e 46: uma prática muito boa é ter uma extensão consistente usada para arquivos nos quais você inclui informações privadas e .gitignoresempre excluir arquivos com essa extensão globalmente (usando o .gitconfigarquivo conforme mencionado em outro lugar para sempre ignorá-lo) para o seu usuário).

Dessa forma, você pode ter, por exemplo:

/projectname/mypasswords.exc 

e se você excluiu *.excglobalmente, sabe que não será confirmado, mesmo se você esquecer de excluir individualmente esse arquivo específico.