Remover dados confidenciais do repositório

O comando git filter-branch e o BFG Repo-Cleaner regravam o histórico do repositório, o que altera os SHAs dos commits existentes que você altera e quaisquer commits dependentes. Os SHAs do commit alterados podem afetar as pull requests abertas no repositório. Recomendamos que você faça merge ou feche todas todas as pull requests abertas antes de remover os arquivos do repositório.

Você pode remover o arquivo com o commit mais recente com git rm. Para obter mais informações sobre como remover um arquivo que foi adicionado com o commit mais recente, consulte "Remover arquivos do histórico do repositório".

Remover um arquivo do histórico do repositório

Usar o BFG

O BFG Repo-Cleaner é uma ferramenta desenvolvida e mantida pela comunidade de código aberto. Ele fornece uma alternativa mais rápida e simples ao git filter-branch para remover dados não desejados. Por exemplo: para remover o arquivo com dados confidenciais sem alterar o commit mais recente, execute:

$ bfg --delete-files YOUR-FILE-WITH-SENSITIVE-DATA

Para substituir todo o texto relacionado no passwords.txt sempre que ele for encontrado no histórico do repositório, execute:

$ bfg --replace-text passwords.txt

Depois que os dados confidenciais são removidos, você deve fazer push forçado das suas alterações para GitHub Enterprise Server.

$ git push --force

Consulte as instruções completas de download e uso na documentação do BFG Repo-Cleaner.

Usar o filter-branch

Para demonstrar como o git filter-branch funciona, mostraremos como remover o arquivo com dados confidenciais do histórico do repositório e adicioná-lo ao .gitignore para impedir a repetição acidental do commit.

1. Se você ainda não tiver uma cópia local do repositório com dados confidenciais no histórico, faça um clone do repositório no computador local.

   $ git clone https://hostname/YOUR-USERNAME/YOUR-REPOSITORY
   > Initialized empty Git repository in /Users/YOUR-FILE-PATH/YOUR-REPOSITORY/.git/
   > remote: Counting objects: 1301, done.
   > remote: Compressing objects: 100% (769/769), done.
   > remote: Total 1301 (delta 724), reused 910 (delta 522)
   > Receiving objects: 100% (1301/1301), 164.39 KiB, done.
   > Resolving deltas: 100% (724/724), done.

2. Acesse o diretório de trabalho do repositório.

   $ cd YOUR-REPOSITORY

3. Execute o seguinte comando substituindo PATH-TO-YOUR-FILE-WITH-SENSITIVE-DATA pelo caminho do arquivo que deseja remover, não apenas o nome do arquivo. Esses argumentos vão:

   • Forçar o Git a processar, mas não fazer checkout, do histórico completo de cada branch e tag
   • Remover o arquivo especificado, bem como qualquer commit vazio gerado como resultado
   • Sobrescrever as tags existentes

     $ git filter-branch --force --index-filter \
       "git rm --cached --ignore-unmatch PATH-TO-YOUR-FILE-WITH-SENSITIVE-DATA" \
       --prune-empty --tag-name-filter cat -- --all
       > Rewrite 48dc599c80e20527ed902928085e7861e6b3cbe6 (266/266)
       > Ref 'refs/heads/main' was rewritten

   Observação: se o arquivo com dados confidenciais existir em qualquer outro caminho (porque foi movido ou renomeado), execute esse comando nesses caminhos também.

4. Adicione o arquivo com dados confidenciais ao .gitignore para impedir a repetição acidental do commit.

   $ echo "YOUR-FILE-WITH-SENSITIVE-DATA" >> .gitignore
   $ git add .gitignore
   $ git commit -m "Add YOUR-FILE-WITH-SENSITIVE-DATA to .gitignore"
   > [main 051452f] Add YOUR-FILE-WITH-SENSITIVE-DATA to .gitignore
   >  1 files changed, 1 insertions(+), 0 deletions(-)

5. Verifique se você removeu todo o conteúdo desejado do histórico do repositório e fez checkout de todos os branches.

6. Quando estiver satisfeito com o estado do repositório, force o push das alterações locais para sobrescrever o repositório do GitHub Enterprise Server e todos os branches presentes no push:

   $ git push origin --force --all
   > Counting objects: 1074, done.
   > Delta compression using 2 threads.
   > Compressing objects: 100% (677/677), done.
   > Writing objects: 100% (1058/1058), 148.85 KiB, done.
   > Total 1058 (delta 590), reused 602 (delta 378)
   > To https://hostname/YOUR-USERNAME/YOUR-REPOSITORY.git
   >  + 48dc599...051452f main -> main (forced update)

7. Para remover o arquivo com dados confidenciais das versões com tag, você também precisará forçar o push das tags do Git:

   $ git push origin --force --tags
   > Counting objects: 321, done.
   > Delta compression using up to 8 threads.
   > Compressing objects: 100% (166/166), done.
   > Writing objects: 100% (321/321), 331.74 KiB | 0 bytes/s, done.
   > Total 321 (delta 124), reused 269 (delta 108)
   > To https://hostname/YOUR-USERNAME/YOUR-REPOSITORY.git
   >  + 48dc599...051452f main -> main (forced update)

8. Entre em contato com o o administrador do site e solicite a remoção das visualizações em cache e das referências aos dados confidenciais em pull requests no GitHub Enterprise Server.

9. Peça para os colaboradores fazerem rebase, e não merge, nos branches criados a partir do histórico antigo do repositório. Um commit de merge poderia reintroduzir o histórico antigo completo (ou parte dele) que você acabou de se dar ao trabalho de corrigir.

10. Depois de algum tempo e de verificar que o git filter-branch não teve nenhum efeito colateral indesejado, você poderá forçar a remoção de todas as referências e a coleta como lixo de todos os objetos do repositório local com os seguintes comandos (usando o Git 1.8.5 ou mais recente):

    $ git for-each-ref --format="delete %(refname)" refs/original | git update-ref --stdin
    $ git reflog expire --expire=now --all
    $ git gc --prune=now
    > Counting objects: 2437, done.
    > Delta compression using up to 4 threads.
    > Compressing objects: 100% (1378/1378), done.
    > Writing objects: 100% (2437/2437), done.
    > Total 2437 (delta 1461), reused 1802 (delta 1048)

    Observação: você também pode conseguir isso fazendo push do histórico filtrado em um repositório novo ou vazio e, em seguida, criando um clone usando o GitHub Enterprise Server.

Evitar commits acidentais no futuro

Há alguns truques simples para evitar fazer commit de coisas não desejadas:

• Use um programa visual, como o GitHub Desktop e o gitk, para fazer commit das alterações. Nos programas visuais, geralmente é mais fácil ver exatamente quais arquivos serão adicionados, excluídos e modificados em cada commit.
• Evite os comandos catch-all git add . e git commit -a na linha de comando— use git add filename e git rm filename para fazer stage de arquivos individuais.
• Use o git add --interactive para revisar e fazer stage das alterações em cada arquivo de forma individual.
• Use o git diff --cached para revisar as alterações que você incluiu no stage para commit. Esse é o diff exato que o git commit produzirá, contanto que você não use o sinalizador -a.

Leia mais

• man page de git filter-branch
• Pro Git: Ferramentas do Git - Reescrevendo o Histórico