Sobre segredos
Os segredos do ambiente de desenvolvimento são variáveis de ambiente criptografadas que você cria nas configurações do GitHub Codespaces para uma organização, um repositório ou uma conta pessoal. Para obter mais informações sobre como criar segredos específicos do usuário, confira "Gerenciar segredos para seus codespaces".
Os segredos que você criou estão disponíveis para uso em GitHub Codespaces. O GitHub usa uma caixa lacrada libsodium para ajudar a garantir que os segredos sejam criptografados antes de chegarem ao GitHub e permaneçam criptografados até você os usar em um fluxo de trabalho.
Os segredos no nível da organização permitem que você compartilhe segredos entre vários repositórios, o que reduz a necessidade de criar segredos duplicados. Você pode usar políticas de acesso para controlar quais repositórios podem usar segredos da organização.
Após criar um segredo, ele estará disponível quando você criar um novo código ou reiniciar o codespace. Se você criou um segredo no GitHub.com e deseja usá-lo em um codespace em execução no momento, interrompa o codespace e reinicie-o. Para obter informações sobre como interromper o codespace, confira "Uso da paleta de comandos do Visual Studio Code no 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, e um segredo criado no nível da organização deve ter um nome exclusivo nesse nível.
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 por organização e 100 segredos por repositório.
Os segredos são limitados a 48 KB.
Segredos recomendados para um repositório
Seu projeto pode exigir segredos de usuário específicos. Por exemplo, para executar o aplicativo em um codespace, talvez o usuário precise fornecer uma chave de API pessoal. Se esse for o caso, você poderá especificar os segredos recomendados na configuração do contêiner de desenvolvimento. Em seguida, o usuário precisará fornecer valores para esses segredos, se ainda não tiver criado esses segredos pessoais, quando usar a página de opções avançadas para criar um codespace. Se o usuário fornecer um valor secreto para uso no codespace, esse segredo será adicionado às configurações pessoais do Codespaces. Ele não precisará inserir um valor para esse segredo quando criar um codespace para esse repositório no futuro. Para obter mais informações, confira "Como especificar segredos recomendados para um repositório".
Adicionar segredos para um repositório
Para criar segredos do ambiente de desenvolvimento para um repositório da organização, você deve ter acesso de administrador.
-
No GitHub.com, navegue até a página principal do repositório.
-
Abaixo do nome do repositório, clique em Configurações. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.
-
Na seção "Segurança" da barra lateral, selecione Segredos e variáveis, then click Codespaces .
-
Na parte superior da página, clique em Novo segredo do repositório.
-
Digite um nome para o segredo na caixa de entrada Nome.
-
Insira o valor para o seu segredo.
-
Clique em Adicionar segredo.
Adicionar segredos para uma organização
Ao criar um segredo de ambiente de desenvolvimento em uma organização, você pode usar uma política para limitar quais repositórios podem acessar esse segredo. Por exemplo, você pode conceder acesso a todos os repositórios ou limitar o acesso a apenas repositórios privados ou a uma lista específica de repositórios.
Para criar segredos no nível da organização, você precisa ter acesso de admin.
-
No GitHub.com, navegue até a página principal da organização.
-
No nome da sua organização, clique Configurações. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.
-
Na seção "Segurança" da barra lateral, selecione Segredos e variáveis, then click Codespaces .
-
Na parte superior da página, clique em Novo segredo.
-
Digite um nome para o segredo na caixa de entrada Nome.
-
Insira o Valor do segredo.
-
Na lista suspensa Acesso do repositório, escolha uma política de acesso.
-
Clique em Adicionar segredo.
Rever o acesso para os segredos do nível da organização
Você pode verificar quais políticas de acesso são aplicadas a um segredo do ambiente de desenvolvimento na sua organização.
-
No GitHub.com, navegue até a página principal da organização.
-
No nome da sua organização, clique Configurações. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.
-
Na seção "Segurança" da barra lateral, selecione Segredos e variáveis, then click Codespaces .
-
A lista de segredos inclui quaisquer permissões e políticas configuradas. Por exemplo:
-
Para obter mais detalhes sobre as permissões configuradas para cada segredo, clique em Atualizar.
