Usando ambientes para implantação

Sobre ambientes

Os ambientes são usados para descrever um alvo geral de implantação como produção, preparo ou desenvolvimento. Quando um fluxo de trabalho de GitHub Actions é implantado em um ambiente, o ambiente é exibido na página principal do repositório. Para obter mais informações sobre a visualização de implantações em ambientes, consulte "Visualizando histórico de implantação".

Você pode configurar ambientes com regras de proteção e segredos. Quando um trabalho de fluxo de trabalho faz referência a um ambiente, o trabalho não será iniciado até que todas as regras de proteção do ambiente sejam aprovadas. Um trabalho também não pode acessar segredos definidos em ambiente até que todas as regras de proteção do ambiente sejam aprovadas.

Regras de proteção de ambiente

As normas de proteção do ambiente exigem a aprovação de condições específicas antes que um trabalho que faz referência ao ambiente possa prosseguir. Você pode usar as regras de proteção de ambiente para exigir uma aprovação manual ou atrasar um trabalho.

Revisores necessários

Use os revisores necessários para exigir que uma pessoa ou equipe específica aprove os trabalhos do fluxo de trabalho que fazem referência ao ambiente. Você pode listar até seis usuários ou equipes como revisores. Os revisores devem ter, pelo menos, acesso de leitura ao repositório. Apenas um dos revisores precisam aprovar o trabalho para que prossiga.

Para obter mais informações sobre os trabalhos de revisão que fazem referência a um ambiente com os revisores necessários, consulte "Revisar implantações".

Temporizador de espera

Use o temporizador de espera para atrasar o trabalho por um período específico de tempo depois que o trabalho for inicialmente acionado. O tempo (em minutos) deve ser um número inteiro entre 0 e 43.200 (30 dias).

Segredos de ambiente

Os segredos armazenados em um ambiente só estão disponíveis para trabalhos de fluxo de trabalho que fazem referência ao ambiente. Se o ambiente exigir aprovação, um trabalho não poderá acessar segredos de ambiente até que um dos revisores necessários o aprove. Para obter mais informações sobre segredos, consulte "Segredos criptografados".

Criar 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, é necessário ter acesso de administrador.

1. No your GitHub Enterprise Server instance, navegue até a página principal do repositório.
2. No nome do seu repositório, clique em Configurações.
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.
   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. Clique Regras de proteção do salvamento.
7. Opcionalmente, especifique o tempo a esperar antes de permitir que os trabalhos do fluxo de trabalho que usam esse ambiente prossigam.
   1. Selecione Temporizador de espera.
   2. Insira o número de minutos para esperar.
   3. Clique Regras de proteção do salvamento.
8. Opcionalmente, especifique quais branches podem implantar neste ambiente. Para obter mais informações sobre os valores possíveis, consulte "Ramificações de implantação".
   1. Selecione a opção desejada no menu suspenso dos Branches de implantação.
   2. Se escolheu Branches selecionados, digite os padrões de nome do branch que você deseja permitir.
9. 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 obter mais informações sobre segredos, consulte "Segredos criptografados".
   1. Em Segredos do ambiente, clique em Adicionar segredo.
   2. Insira o nome do segredo.
   3. Insira o valor do segredo.
   4. Clique em Add secret (Adicionar segredo).

Executar um fluxo de trabalho que faz referência a um ambiente que não existe criará um ambiente com o nome referenciado. O novo ambiente não terá nenhuma regra de proteção ou segredos configurados. 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.

Usando um ambiente

Cada trabalho em um fluxo de trabalho pode fazer referência a um único ambiente. Todas as regras de proteção configuradas para o ambiente têm de ser aprovadas antes que um trabalho de referência ao ambiente seja enviado a um executor. O trabalho só pode acessar os segredos do ambiente depois que for enviado para um executor.

Quando um fluxo de trabalho faz referência a um ambiente, o ambiente aparecerá nas implantações do repositório. Para obter mais informações sobre a visualização de implementações atuais e anteriores, consulte "Visualizar histórico de implantação".

Você pode especificar um ambiente para cada tarefa do seu fluxo de trabalho. Para fazer isso, adicione um chave a função .<job_id>.environment seguida pelo nome do ambiente.

Por exemplo, esse fluxo de trabalho usará um ambiente denominado produção.

name: Deployment

on:
  push:
    branches:
      - main

jobs:
  deployment:
    runs-on: ubuntu-latest
    environment: production
    steps:
      - name: deploy
        # ...deployment-specific steps

Quando o fluxo de trabalho acima é executado, o trabalho de implantação estará sujeito a todas as regras configuradas para o ambiente de produção. Por exemplo, se o ambiente exigir revisores, o trabalho fará a pausa até que um dos revisores aprove o trabalho.

Você também pode especificar uma URL para o ambiente. A URL especificada aparecerá na página de implantações do repositório (acessado clicando em Ambientes na página inicial do seu repositório) e no gráfico de visualização para a execução do fluxo de trabalho. Se um pull request acionou o fluxo de trabalho, o URL também é exibido como um botão Visualizar implantação na linha do tempo do pull request.

name: Deployment

on:
  push:
    branches:
      - main

jobs:
  deployment:
    runs-on: ubuntu-latest
    environment: 
      name: production
      url: https://github.com
    steps:
      - name: deploy
        # ...deployment-specific steps

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, é necessário ter acesso de administrador.

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. No your GitHub Enterprise Server instance, navegue até a página principal do repositório.
2. No nome do seu repositório, clique em Configurações.
3. Na barra lateral esquerda, clique em Ambientes.
4. Ao lado do ambiente que você deseja excluir, clique em .
5. Clique em Eu entendi, exclua este ambiente.

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

Quando um trabalho de fluxo de trabalho faz referência a execuções de um ambiente, ele cria um objeto de implantação com a propriedade ambiente definida para o nome do seu ambiente. À medida que o fluxo de trabalho avança, ele também cria objetos de estado de implantação com a propriedade ambiente definida para o nome do seu ambiente. A propriedade environment_url definida como URL para o ambiente (se especificado no fluxo de trabalho), e a propriedade estado definida como estado 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, consulte "Repositórios" (API REST), "Objetos" (GraphQL API) ou "Eventos de webhook e cargas".

Próximas etapas

GitHub Actions fornece várias funcionalidades para gerenciar suas implantações. Para obter mais informações, consulte "Implantando com o GitHub Actions".