Skip to main content

Usando ambientes para implantação

Você pode configurar ambientes com regras de proteção e segredos. Um trabalho de fluxo de 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.

Ambientes, segredos de ambiente e regras de proteção de ambiente estão disponíveis em repositórios públicos para todos os produtos. 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. Para acessar outras regras de proteção de ambiente em repositórios privados ou internos, você deve usar GitHub Enterprise.

Sobre ambientes

Os ambientes são usados para descrever um destino de implantação geral, como production, staging ou development. 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 como ver implantações em ambientes, confira "Como ver o histórico de implantações".

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 do 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 regras de proteção ambiental para exigir uma aprovação manual, atrasar um trabalho ou restringir o ambiente a certos branches.

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 como revisar trabalhos que referenciam um ambiente com revisores obrigatórios, confira "Como 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).

Implementar branches

Use os branches de implantação para restringir quais branches podem ser implementados no ambiente. Abaixo, estão as opções para branches de implantação para um ambiente:

  • Todos os branches: todos os branches do repositório podem ser implantados no ambiente.

  • Branches protegidos: somente os branches com regras de proteção de branch habilitadas podem ser implantados no ambiente. Se nenhuma regra de proteção de branch for definida para qualquer branch no repositório, todos os branches poderão implantar. Para obter mais informações sobre as regras de proteção de branch, confira "Sobre os branches protegidos".

  • Branches selecionados: somente os branches que correspondem aos seus padrões de nome especificados podem ser implantados no ambiente.

    Por exemplo, se você especificar releases/* como uma regra de branch de implantação, somente os branches cujos nomes começam com releases/ podem ser implantados no ambiente. (Os caracteres curinga não corresponderão a /. Para fazer a correspondência dos branches que começam com release/ e contêm uma barra única adicional, use release/*/*). Se você adicionar main como uma regra de branch de implantação, um branch chamado main também poderá ser implantado no ambiente. Para obter mais informações sobre as opções de sintaxe para branches de implantação, confira a documentação de File.fnmatch do Ruby.

Segredos do 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, confira "Segredos criptografados".

Observação: os fluxos de trabalho executados em executores auto-hospedados não são executados em um contêiner isolado, mesmo que usem ambientes. Os segredos de ambiente devem ser tratados com o mesmo nível de segurança que os segredos do repositório e da organização. Para obter mais informações, confira "Proteção de segurança do GitHub Actions".

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. No your enterprise, navegue até a página principal do repositório. 1. Abaixo do nome do repositório, clique em Configurações. Botão Configurações do repositório 1. Na barra lateral esquerda, clique em Ambientes. 1. Clique em Novo ambiente. 1. 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.
  2. 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 em Salvar regras de proteção.
  3. 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 em Salvar regras de proteção.
  4. Opcionalmente, especifique quais branches podem implantar neste ambiente. Para obter mais informações sobre os valores possíveis, confira "Branches de implantação".
    1. Selecione a opção desejada no menu suspenso Branches de implantação.
    2. Se você escolheu Branches selecionados, insira os padrões de nomes de branches que deseja permitir.
  5. 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, confira "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 Adicionar segredo.

Também é possível criar e configurar ambientes por meio da API REST. Para obter mais informações, confira "Ambientes de implantação", "Segredos do GitHub Actions" e "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. 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 como ver as implantações atuais e anteriores, confira "Como ver o histórico de implantações".

Você pode especificar um ambiente para cada tarefa do seu fluxo de trabalho. Para fazer isso, adicione uma chave jobs.<job_id>.environment seguida do nome do ambiente.

Por exemplo, este fluxo de trabalho usará um ambiente chamado production.

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 for executado, o trabalho deployment estará sujeito às regras configuradas para o ambiente production. 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 será exibida na página de implantações do repositório (acessada por meio de um clique em Ambientes na home page do repositório) e no grafo de visualização da execução de fluxo de trabalho. Se uma solicitação de pull disparar o fluxo de trabalho, a URL também será exibida como um botão Exibir implantação na linha do tempo da solicitação de pull.

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

Gráfico do fluxo de trabalho com o URL

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. No your enterprise, navegue até a página principal do repositório. 1. Abaixo do nome do repositório, clique em Configurações. Botão Configurações do repositório 1. Na barra lateral esquerda, clique em Ambientes.
  2. Ao lado do ambiente que você deseja excluir, clique em .
  3. Clique em Entendi. Excluir este ambiente.

Também é possível excluir ambientes por meio da API REST. Para saber mais, confira "Ambientes".

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 "Repositórios" (API REST), "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 obter mais informações, confira "Implantação com o GitHub Actions".