Skip to main content

Gerenciar segredos criptografados para seus codespaces

Você pode armazenar informações confidenciais, como tokens, que você deseja acessar nos seus codespaces por meio de variáveis de ambiente.

Os GitHub Codespaces estão disponíveis para organizações que usam o GitHub Team ou o GitHub Enterprise Cloud. GitHub Codespaces também está disponível como uma versão beta limitado para usuários individuais nos planos GitHub Free e GitHub Pro. Para obter mais informações, confira "produtos de GitHub".

Sobre os segredos criptografados para os GitHub Codespaces

Você pode adicionar segredos criptografados a sua conta pessoal que deseja usar nos seus codespaces. Por exemplo, você pode querer armazenar e acessar as seguintes informações confidenciais como segredos criptografados.

Você pode escolher quais repositórios devem ter acesso a cada segredo. Em seguida, você pode usar o segredo em qualquer código que criar para um repositório que tiver acesso ao segredo.

Once you have created a secret, it will be available when you create a new codespace or restart the codespace. To use a secret that you've just created in a current codespace, you will need to stop the codespace and resume it. For information about stopping the codespace, see "Using the Visual Studio Code Command Palette in GitHub Codespaces."

Nomeando segredos

As regras a seguir aplicam-se aos nomes dos segredos:

  • Os nomes secretos só podem conter caracteres alfanuméricos ([a-z], [A-Z], [0-9]) ou sublinhados (_). Espaços não são permitidos.

  • Os nomes secretos não devem começar com o prefixo GITHUB_.

  • Os nomes dos segredos não devem começar com um número.

  • Nomes dos segredos não diferenciam maiúsculas de minúsculas.

  • Os nomes dos segredos devem ser únicos no nível em que são criados. Por exemplo, um segredo criado no nível do repositório deve ter um nome exclusivo nesse repositório.

    Se houver um segredo com o mesmo nome em vários níveis, o segredo no nível mais baixo terá precedência. Por exemplo, se um segredo a nível de organização tiver o mesmo nome que um segredo a nível de repositório, o segredo a nível de repositório terá prioridade.

Limites para segredos

Você pode armazenar até 100 segredos para GitHub Codespaces.

Os segredos são limitados a 64 kB.

Adicionar um segredo

  1. No canto superior direito de qualquer página, clique na foto do seu perfil e em Configurações.

    Ícone Settings (Configurações) na barra de usuário 1. Na seção "Código, planejamento e automação" da barra lateral, clique em Codespaces.

  2. À direita de "Segredos de codespaces", clique em Novo segredo. Botão "Novo segredo"

  3. Em "Nome", digite um nome para seu segredo. Caixa de texto "Nome" 1. Em "Valor", digite o valor do seu segredo. Caixa de texto "Valor" 1. Selecione o menu suspenso "Acesso ao repositório" e, em seguida, clique em um repositório que você quer que tenha acesso ao segredo. Repita esse procedimento para cada repositório que você quer que tenha acesso ao segredo. Menu suspenso "Acesso ao repositório"

  4. Clique em Adicionar segredo.

Editar um segredo

Você pode atualizar o valor de um segredo existente, bem como alterar quais repositórios podem acessar um segredo.

  1. No canto superior direito de qualquer página, clique na foto do seu perfil e em Configurações.

    Ícone Settings (Configurações) na barra de usuário 1. Na seção "Código, planejamento e automação" da barra lateral, clique em Codespaces.

  2. Em "Segredos de codespaces", à direita do segredo que você deseja editar, clique em Atualizar. Botão "Atualizar"

  3. Em "Valor", clique em Inserir um novo valor. Link "Inserir um novo valor" 1. Em "Valor", digite o valor do seu segredo. Caixa de texto "Valor" 1. Selecione o menu suspenso "Acesso ao repositório" e, em seguida, clique em um repositório que você quer que tenha acesso ao segredo. Repita esse procedimento para cada repositório que você quer que tenha acesso ao segredo. Menu suspenso "Acesso ao repositório"

  4. Opcionalmente, para remover o acesso do segredo a um repositório, desmarque o repositório. Caixas de seleção para remover o acesso aos repositórios

  5. Clique em Salvar alterações.

Excluir um segredo

  1. No canto superior direito de qualquer página, clique na foto do seu perfil e em Configurações.

    Ícone Settings (Configurações) na barra de usuário 1. Na seção "Código, planejamento e automação" da barra lateral, clique em Codespaces.

  2. Em "Segredos de codespaces", à direita do segredo que você deseja excluir, clique em Excluir. Botão "Excluir"

  3. Leia o aviso e clique em OK. Confirmação para excluir um segredo

Usando segredos

Um segredo é exportado como uma variável de ambiente para a sessão de terminal do usuário.

Exibir o valor de um segredo exportado no terminal

Você pode usar segredos em um codespace depois que o codespace for criado e estiver em execução. Por exemplo, um segredo pode ser usado:

  • Ao iniciar um aplicativo do terminal integrado ou da sessão SSH.
  • Dentro de um script de ciclo de vida do contêiner de desenvolvimento executado após a execução do codespace. Para obter mais informações sobre scripts de ciclo de vida do contêiner de desenvolvimento, confira a documentação sobre contêineres de desenvolvimento: Especificação.

Os segredos do codespace não podem ser usados durante:

  • O tempo de build do codespace (ou seja, em um Dockerfile ou ponto de entrada personalizado).
  • Em um recurso de contêiner de desenvolvimento. Para obter mais informações, confira o atributo features na documentação sobre contêineres de desenvolvimento: Especificação.

Leitura adicional