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 obter mais informações, 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 obter mais informações, confira "Parar e iniciar um codespace".

Se GitHub Codespaces não assinar um commit, você poderá ver um erro semelhante ao a seguir.

$ git commit -m 'Initial commit'
error: gpg failed to sign the data
fatal: failed to write commit object

Você poderá encontrar esse erro se:

Tiver desabilitado a verificação GPG e estiver tentando fazer um commit regular e não assinado em um codespace existente.
Você habilitou a verificação GPG, mas substituiu a configuração do Git necessária para GitHub Codespaces assinar seus commits, por exemplo, vinculando GitHub Codespaces a um repositório dotfiles que contém arquivos de configuração do Git.

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.

Shell

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 pela configuração conflitante

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.

Definição de configuração	Valor necessário
`user.name`	Precisa corresponder ao nome completo definido em seu perfil do GitHub
`credential.helper`	Precisa ser definida como `/.codespaces/bin/gitcredential_github.sh`
`gpg.program`	Precisa ser definida como `/.codespaces/bin/gh-gpgsign`

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.

Observação: todas as alterações no repositório dotfiles serão aplicadas a novos codespaces, mas não aos codespaces existentes.

No computador local, abra um terminal.
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
```
Envie por push a alteração para o repositório dotfiles em GitHub.
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.