Como resolver problemas de verificação GPG para o GitHub Codespaces

Se você habilitar a verificação GPG, o GitHub Codespaces assina automaticamente os seus commits em codespaces que você cria com base em repositórios selecionados. Para saber mais, confira Como gerenciar a verificação GPG para o GitHub Codespaces.

Depois de habilitar a verificação GPG, ela entrará em vigor automaticamente em novos codespaces criados com base nos repositórios relevantes. Para que a verificação GPG entre em vigor em um codespace ativo existente, você precisará parar e reiniciar o codespace. Para saber mais, confira Parar e iniciar um codespace.

Se o GitHub Codespaces não assinar um commit, você poderá ver a mensagem de erro gpg failed to sign the data na linha de comando ou em uma janela pop-up do Visual Studio Code.

As seções a seguir deste artigo fornecem conselhos de solução de problemas para causas comuns desse erro.

• Se a verificação GPG tiver sido habilitada anteriormente nas configurações do GitHub Codespaces, e você desabilitou recentemente a verificação GPG ou removeu um repositório de sua lista de repositórios confiáveis, o Git ainda pode estar tentando assinar seus commits. Para obter mais informações, confira Erros depois de desabilitar a verificação GPG.
• Se a verificação GPG estiver habilitada no codespace, talvez você tenha substituído a configuração do Git necessária para assinar seus commits. Para obter mais informações, confira Erros causados por configuração conflitante do Git.
• Se a verificação GPG estiver desabilitada no codespace e você estiver se deparando com o erro ao tentar fazer commit na exibição "Controle do Código-Fonte" no VS Code, isso pode ser devido às configurações do VS Code. Para obter mais informações, confira Erros na exibição "Controle do código-fonte" do VS Code.

Erros após desabilitar a verificação GPG

Quando você habilita a verificação GPG, GitHub Codespaces assina todos os commits que você faz em codespaces por padrão. Ele faz isso definindo o valor de configuração do Git commit.gpgsign como true.

Se você tiver desabilitado a verificação GPG e estiver trabalhando em um codespace existente, esse valor ainda será definido como true. Isso significa que GitHub Codespaces tentará assinar seus commits, mas não será possível fazer isso, pois você desabilitou a configuração de verificação GPG.

Para continuar fazendo commits regulares e não assinados em seu codespace, redefina commit.gpgsign para o valor padrão de false inserindo o comando a seguir no terminal.

git config --unset commit.gpgsign

git config --unset commit.gpgsign

Para verificar se o valor foi removido corretamente da configuração, você pode inserir git config --list. Você não deve ver um valor para commit.gpgsign na lista.

Erros causados por configuração conflitante do Git

Para assinar automaticamente seus commits, GitHub Codespaces define determinados valores de configuração do Git em seu codespace. Se você substituir os valores definidos por GitHub Codespaces, talvez não consiga assinar seus commits.

Você poderá estar substituindo inadvertidamente esses valores se tiver vinculado GitHub Codespaces a um repositório dotfiles que contém arquivos de configuração do Git. Para saber mais sobre como usar dotfiles com o GitHub Codespaces, confira Como personalizar o GitHub Codespaces para sua conta.

Verificar se há uma configuração conflitante

Para assinar seus commits com GPG, GitHub Codespaces define automaticamente os valores de configuração do Git a seguir no nível do sistema.

Para verificar se esses valores estão definidos corretamente em um codespace, você pode usar o comando git config --list --show-origin. Como GitHub Codespaces define essa configuração no nível do sistema, as definições de configuração necessárias devem vir de /usr/local/etc/gitconfig.

$ git config --list --show-origin
file:/usr/local/etc/gitconfig   credential.helper=/.codespaces/bin/gitcredential_github.sh
file:/usr/local/etc/gitconfig   user.name=Mona Lisa
file:/usr/local/etc/gitconfig   gpg.program=/.codespaces/bin/gh-gpgsign

Além dos valores listados acima, você poderá encontrar erros se os dotfiles usados em seus codespaces contiverem qualquer um dos valores a seguir.

• O valor de configuração do Git user.signingkey
• O valor de configuração do Git commit.gpgsign
• Um GITHUB_TOKEN definido manualmente

Remover a configuração conflitante

Se você quiser manter a verificação GPG automática para o GitHub Codespaces habilitado, será necessário remover qualquer configuração conflitante dos dotfiles usados em seus codespaces.

Por exemplo, se o arquivo global .gitconfig em seu computador local contiver um valor gpg.program e você tiver enviado esse arquivo por push a um repositório dotfiles vinculado a GitHub Codespaces, talvez você queira remover gpg.program desse arquivo e defini-lo no nível do sistema em seu computador local.

1. No computador local, abra um terminal.

2. Para remover o valor conflitante de ~/.gitconfig (Mac/Linux) ou C:\Users\YOUR-USER\.gitconfig (Windows), use o comando git config --global --unset.

   git config --global --unset gpg.program
   

3. Envie por push a alteração para o repositório dotfiles em GitHub.

4. Opcionalmente, para manter a configuração local, defina o valor novamente em um arquivo de configuração do Git que você não envia por push para o repositório dotfiles.

   Por exemplo, você pode usar o sinalizador --system para definir a configuração no arquivo no nível do sistema em PATH/etc/gitconfig, em que PATH é o diretório no qual o Git está instalado em seu sistema.

   git config --system gpg.program gpg2
   

Como alternativa, se o repositório dotfiles contiver um script de instalação em um arquivo reconhecido, como install.sh, você poderá usar a variável de ambiente $CODESPACES para adicionar lógica condicional, como a configuração gpg.program somente quando você não estiver em um codespace. No exemplo a seguir, -z "$CODESPACES" retornará true se você não estiver em um codespace.

if [ -z "$CODESPACES" ]; then
  git config --global gpg.program gpg2
fi

if [ -z "$CODESPACES" ]; then
  git config --global gpg.program gpg2
fi

Erros na exibição "Controle do Código-Fonte" do VS Code

Se a verificação GPG estiver desabilitada em suas configurações do GitHub Codespaces ou o repositório do qual você criou o codespace não estiver em sua lista de repositórios confiáveis, o Git não deverá tentar assinar seus commits. Se você encontrar um erro de assinatura ao tentar fazer commit na exibição "Controle do Código-Fonte" no VS Code, deverá verificar as configurações do VS Code no seu codespace.

1. No canto inferior esquerdo da janela, selecione e clique em Configurações.

   

2. Na guia "Usuário", na barra de pesquisa, pesquise "gpg".

3. Verifique se a configuração "Habilita a assinatura de commit com GPG ou X.509" está desmarcada.

   

Se você achar que essa configuração está habilitada, desmarque a caixa de seleção para que o VS Code pare de tentar assinar seus commits ou habilite a verificação GPG no repositório em que você está trabalhando para que os commits possam ser assinados com êxito.

Se você alterar as configurações do VS Code, deverá garantir que a Sincronização de Configurações esteja habilitada se quiser compartilhar as alterações com outros codespaces que você criar. Você só deve ativar a Sincronização de Configurações em um codespace criado por meio de um repositório em que você confia. Para saber mais, confira Como personalizar o GitHub Codespaces para sua conta.

Leitura adicional

• Sobre a verificação de assinatura de commit
• git config na documentação oficial do Git