Gerenciar ambientes para implantação

Você pode criar ambientes e proteger esses ambientes com regras de proteção de implantação. Um trabalho que faz referência a um ambiente deve seguir quaisquer regras de proteção para o ambiente antes de executar ou acessar os segredos do ambiente.

Quem pode usar esse recurso?

Repository owners

Ambientes, segredos de ambiente e regras de proteção de implantação estão disponíveis em repositórios públicos para todos os planos atuais do GitHub. Eles não estão disponíveis em planos herdados, como Bronze, Prata ou Ouro. Para acesso a ambientes, segredos de ambiente e branches de implantação em repositórios privados ou internos, você deve usar GitHub Pro, GitHub Team ou GitHub Enterprise.

Neste artigo

Pré-requisitos

Criando um ambiente

Para configurar um ambiente em um repositório de conta pessoal, você deve ser o proprietário do repositório. Para configurar um ambiente em um repositório da organização, você precisa ter acesso de admin.

  1. Em GitHub, acesse a página principal do repositório.

  2. 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.

    Captura de tela de um cabeçalho de repositório que mostra as guias. A guia "Configurações" é realçada por um contorno laranja-escuro.

  3. Na barra lateral esquerda, clique em Ambientes.

  4. Clique em Novo ambiente.

  5. Insira um nome para o ambiente e clique em Configurar ambiente. Os nomes de ambiente não diferenciam maiúsculas de minúsculas. Um nome de ambiente não pode exceder 255 caracteres e deve ser único dentro do repositório.

  6. Opcionalmente, especifique as pessoas ou equipes que devem aprovar os trabalhos do fluxo de trabalho que usam esse ambiente. Para saber mais, confira Implantações e ambientes.

    1. Selecione Revisores necessários.
    2. Insira até até 6 pessoas ou equipes. Apenas um dos revisores precisam aprovar o trabalho para que prossiga.
    3. Opcionalmente, para impedir que os usuários aprovem as execuções de fluxos de trabalho que eles dispararam, selecione Impedir a auto-revisão.
    4. Clique em Salvar regras de proteção.

  7. Opcionalmente, especifique o tempo a esperar antes de permitir que os trabalhos do fluxo de trabalho que usam esse ambiente prossigam. Para saber mais, confira Implantações e ambientes.

    1. Selecione Temporizador de espera.
    2. Insira o número de minutos para esperar.
    3. Clique em Salvar regras de proteção.

  8. Opcionalmente, não permite ignorar regras de proteção configuradas. Para saber mais, confira Implantações e ambientes.

    1. Desmarque Permitir que os administradores ignorem as regras de proteção configuradas.
    2. Clique em Salvar regras de proteção.

  9. Opcionalmente, habilite quaisquer regras personalizadas de proteção de implantação que tenham sido criadas com o GitHub Apps. Para saber mais, confira Implantações e ambientes.

    1. Selecione a regra de proteção personalizada que você deseja habilitar.
    2. Clique em Salvar regras de proteção.

  10. Opcionalmente, especifique quais branches e tags podem ser implantados neste ambiente. Para saber mais, confira Implantações e ambientes.

    1. Selecione a opção desejada no menu suspenso Branches de implantação.

    2. Se você escolheu Selected branches and tags, para adicionar uma nova regra, selecione Add deployment branch or tag rule

    3. No menu suspenso "Ref type", dependendo da regra que você deseja aplicar, selecione Branch ou Tag.

    4. Insira o padrão de nome para o branch ou tag que deseja permitir.

      Observação

      Os padrões de nomes devem ser configurados individualmente para branches ou rótulos.

    5. Clique em Adicionar regra.

  11. Opcionalmente, adicione segredos de ambiente. Esses segredos só estão disponíveis para trabalhos de fluxo de trabalho que usam o ambiente. Além disso, os trabalhos do fluxo de trabalho que usam este ambiente só podem acessar esses segredos após todas as regras configuradas (por exemplo, revisores obrigatórios). Para saber mais, confira Implantações e ambientes.

    1. Em Segredos do ambiente, clique em Adicionar Segredo.
    2. Insira o nome do segredo.
    3. Insira o valor do segredo.
    4. Clique em Adicionar segredo.

  12. Opcionalmente, adicione variáveis de ambiente. Essas variáveis só ficam disponíveis para trabalhos de fluxo de trabalho que usam o ambiente e só podem ser acessadas usando o contexto vars. Para saber mais, confira Implantações e ambientes.

    1. Em Variáveis de ambiente, clique em Adicionar Variável.
    2. Informe o nome da variável.
    3. Informe o valor da variável.
    4. Clique em Adicionar variável.

Também é possível criar e configurar ambientes por meio da API REST. Para saber mais, confira Pontos de extremidade da API REST para ambientes de implantação, Pontos de extremidade da API REST para segredos do GitHub Actions, Pontos de extremidade da API REST para variáveis do GitHub Actions e Pontos de extremidade da API REST para políticas de branch de implantação.

Executar um fluxo de trabalho que faz referência a um ambiente que não existe criará um ambiente com o nome referenciado. Se o ambiente for criado a partir da execução de compilações de página implícitas (por exemplo, de uma fonte de ramificação ou pasta), a ramificação fonte será adicionada como uma regra de proteção ao ambiente. Caso contrário, o novo ambiente criado não terá nenhuma regra de proteção ou segredo configurado. Qualquer pessoa que possa editar fluxos de trabalho no repositório pode criar ambientes por meio de um arquivo de fluxo de trabalho, mas apenas os administradores do repositório podem configurar o ambiente.

Excluir um ambiente

Para configurar um ambiente em um repositório de conta pessoal, você deve ser o proprietário do repositório. Para configurar um ambiente em um repositório da organização, você precisa ter acesso de admin.

A exclusão de um ambiente apagará todos os segredos e regras de proteção associados ao ambiente. Todos os trabalhos que estejam atualmente em espera devido às regras de proteção do ambiente eliminado falharão automaticamente.

  1. Em GitHub, acesse a página principal do repositório.

  2. 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.

    Captura de tela de um cabeçalho de repositório que mostra as guias. A guia "Configurações" é realçada por um contorno laranja-escuro.

  3. Na barra lateral esquerda, clique em Ambientes.

  4. Ao lado do ambiente que você deseja excluir, clique em .

  5. Clique em Entendi. Excluir este ambiente.

Também é possível excluir ambientes por meio da API REST. Para saber mais, confira Pontos de extremidade da API REST para repositórios.

Como os ambientes relacionam-se com as implantações

Quando um trabalho de fluxo de trabalho que referencia um ambiente é executado, ele cria um objeto de implantação com a propriedade environment definida como o nome do ambiente. À medida que o fluxo de trabalho progride, ele também cria objetos de status de implantação com a propriedade environment definida como o nome do ambiente, a propriedade environment_url definida como a URL para o ambiente (se especificado no fluxo de trabalho) e a propriedade state definida como o status do trabalho.

Você pode acessar esses objetos por meio da API REST ou API do GraphQL. Você também pode assinar esses eventos de webhook. Para obter mais informações, confira Pontos de extremidade da API REST para repositórios, Objetos (API do GraphQL) ou Eventos e cargas de webhook.

Próximas etapas

GitHub Actions fornece várias funcionalidades para gerenciar suas implantações. Para saber mais, confira Implantando com GitHub Actions.