Como especificar segredos recomendados para um repositório

Sobre os segredos recomendados

Se um projeto precisar de segredos específicos do usuário para ser configurado, você poderá solicitar que as pessoas façam isso ao criar um codespace. Faça isso adicionando uma configuração a um arquivo de configuração de contêiner de desenvolvimento para o repositório.

Depois que você especificar os segredos recomendados, se as pessoas ainda não tiverem criado esses segredos nas configurações pessoais do Codespaces, elas precisarão fazer isso quando usarem o método de opções avançadas de criação de um codespace. Faça isso no GitHub clicando no botão Código, clicando na guia Codespaces, selecionando e clicando em Novo com opções.

Os segredos recomendados são listados na parte inferior da página.

Cada segredo recomendado é exibido de uma destas três maneiras:

• Se a pessoa não definiu o segredo recomendado nas configurações do Codespaces, uma caixa de entrada é exibida, permitindo que ela crie o segredo agora. Uma descrição e um link para mais informações são exibidos se você os configurou. A inserção de um valor é opcional.
• Se a pessoa já criou o segredo recomendado, mas não o associou a esse repositório, ela pode selecionar uma caixa de seleção para adicionar essa associação. Esse procedimento é opcional.
• Se a pessoa já criou o segredo recomendado e o associou a esse repositório, uma caixa de seleção previamente selecionada é exibida.

Quando especificar segredos recomendados para um projeto

Você deve usar os segredos recomendados para os segredos de ambiente de desenvolvimento que precisam o usuário que cria o codespace precisa fornecer, em vez do proprietário do repositório ou da organização. Por exemplo, se você tiver um projeto público e os usuários precisarem fornecer uma chave de API pessoal para executar o aplicativo no seu projeto, você poderá especificar um segredo recomendado para que os usuários sejam solicitados a fornecer a chave como o valor do segredo quando usarem a página de opções avançadas para criar um codespace.

Como alternativa, para os segredos de ambiente de desenvolvimento que o proprietário do repositório ou da organização pode fornecer, como chaves de API compartilhadas com uma equipe, você pode definir os segredos no nível do repositório ou da organização. Para saber mais, confira Gerenciando segredos do ambiente de desenvolvimento para seu repositório ou organização.

Como especificar segredos recomendados na configuração do contêiner de desenvolvimento

1. Configure os codespaces criados para seu repositório adicionando configurações a um arquivo devcontainer.json. Se o repositório ainda não contiver um arquivo devcontainer.json, adicione um agora. Confira "Adicionando uma configuração de contêiner de desenvolvimento ao repositório".

2. Edite o arquivo devcontainer.json, adicionando a propriedade secrets no nível superior do arquivo, dentro do objeto JSON delimitador. Por exemplo:

   JSON

   "secrets": {
     "NAME_OF_SECRET_1": {
       "description": "This is the description of the secret.",
       "documentationUrl": "https://example.com/link/to/info"
     },
     "NAME_OF_SECRET_2": { }
   }
   

3. Adicione uma propriedade dentro de secrets para cada segredo que você deseja recomendar. Por exemplo, altere NAME_OF_SECRET_1 e NAME_OF_SECRET_2, no exemplo de código anterior, para os nomes dos segredos que as pessoas devem criar nas respectivas configurações pessoais do Codespaces.

4. Opcionalmente, forneça uma descrição para cada segredo e uma URL para mais informações sobre esse segredo.

   Você pode omitir description e documentationUrl, conforme mostrado pela NAME_OF_SECRET_2 no exemplo de código anterior.

5. Especifique segredos adicionais, conforme necessário.

6. Salve o arquivo e faça commit as alterações no branch necessário do repositório.

Leitura adicional

• Como criar um codespace para um repositório