Gerenciar segredos criptografados

4 minutos

Segredos são variáveis de ambiente criptografadas que você pode criar para armazenar tokens, credenciais ou qualquer outro tipo de informação confidencial em que seus fluxos de trabalho e ações do GitHub Actions possam confiar. Uma vez criados, eles ficam disponíveis para uso nos fluxos de trabalho e ações que têm acesso à organização, repositório ou ambiente de repositório onde estão armazenados.

Nesta seção, você explorará as diferentes ferramentas e estratégias disponíveis no GitHub Enterprise Cloud e no GitHub Enterprise Server para gerenciar o uso de segredos criptografados. Também explicaremos como acessar segredos criptografados em seus fluxos de trabalho e ações.

Gerencie segredos criptografados no nível da organização

Criar segredos criptografados no nível da organização para armazenar informações confidenciais é uma ótima maneira de garantir a segurança dessas informações, minimizando a sobrecarga de gerenciamento em sua empresa.

Digamos que alguns desenvolvedores que escrevem fluxos de trabalho em sua organização do GitHub precisem das credenciais para implantar código na produção em alguns de seus fluxos de trabalho. Para evitar o compartilhamento dessa informação confidencial, você pode criar um segredo criptografado contendo as credenciais no nível da organização. Dessa forma, as credenciais podem ser usadas nos fluxos de trabalho sem serem expostas.

Para criar um segredo ao nível da organização, aceda às Definições da sua organização e, na barra lateral, selecione Segredos e variáveis > Ações > Novo segredo da organização. Na tela exibida, insira um nome e um valor e escolha uma política de acesso ao repositório para seu segredo:

Nova tela secreta para organizações.

A política de acesso aparece por baixo do segredo na lista secreta depois de guardada:

Exemplo de segredos criptografados com política de acesso exibida.

Você pode selecionar Atualizar para obter mais detalhes sobre as permissões configuradas para seu segredo.

Gerencie segredos criptografados no nível do repositório

Se você precisar de um segredo criptografado para definir o escopo de um repositório específico, o GitHub Enterprise Cloud e o GitHub Enterprise Server também permitem criar segredos no nível do repositório.

Para criar um segredo no nível do repositório, vá para Configurações do repositório e, na barra lateral, selecione Segredos e variáveis > Ações > Novo segredo do repositório. No ecrã apresentado, introduza um nome e um valor para o seu segredo:

Nova tela secreta para repositórios.

Acesse segredos criptografados em ações e fluxos de trabalho

Em fluxos de trabalho

Para acessar um segredo criptografado em um fluxo de trabalho, você deve usar o secrets contexto em seu arquivo de fluxo de trabalho. Por exemplo:

steps:
  - name: Hello world action
    with: # Set the secret as an input
      super_secret: ${{ secrets.SuperSecret }}
    env: # Or as an environment variable
      super_secret: ${{ secrets.SuperSecret }}

Em ações

Para acessar um segredo criptografado em uma ação, você deve especificar o segredo como um input parâmetro no action.yml arquivo de metadados. Por exemplo:

inputs:
  super_secret:
    description: 'My secret token'
    required: true

Se você precisar acessar o segredo criptografado no código da ação, o código da ação poderá ler o valor da entrada usando a $SUPER_SECRET variável de ambiente.

Aviso