Deploying with GitHub Actions

Learn how to control deployments with features like environments and concurrency.

Introduction

GitHub Actions offers features that let you control deployments. You can:

  • Trigger workflows with a variety of events.
  • Configure environments to set rules before a job can proceed and to limit access to secrets.
  • Use concurrency to control the number of deployments running at a time.

For more information about continuous deployment, see "About continuous deployment."

Prerequisites

You should be familiar with the syntax for GitHub Actions. For more information, see "Learn GitHub Actions."

Triggering your deployment

You can use a variety of events to trigger your deployment workflow. Some of the most common are: pull_request, push, and workflow_dispatch.

For example, a workflow with the following triggers runs whenever:

  • There is a push to the main branch.
  • A pull request targeting the main branch is opened, synchronized, or reopened.
  • Someone manually triggers it.
on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main
  workflow_dispatch:

For more information, see "Events that trigger workflows."

Using environments

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. Você pode usar ambientes para exigir aprovação para um trabalho para prosseguir, restringir quais branches podem acionar um fluxo de trabalho ou limitar o acesso a segredos. Para obter mais informações sobre criar ambientes, consulte "Usando ambientes para implantação".

Using concurrency

Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. You can use concurrency so that an environment has a maximum of one deployment in progress and one deployment pending at a time.

Note: concurrency and environment are not connected. The concurrency value can be any string; it does not need to be an environment name. Additionally, if another workflow uses the same environment but does not specify concurrency, that workflow will not be subject to any concurrency rules.

For example, when the following workflow runs, it will be paused with the status pending if any job or workflow that uses the production concurrency group is in progress. It will also cancel any job or workflow that uses the production concurrency group and has the status pending. This means that there will be a maximum of one running and one pending job or workflow in that uses the production concurrency group.

name: Deployment

concurrency: production

on:
  push:
    branches:
      - main

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

You can also specify concurrency at the job level. This will allow other jobs in the workflow to proceed even if the concurrent job is pending.

name: Deployment

on:
  push:
    branches:
      - main

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

You can also use cancel-in-progress to cancel any currently running job or workflow in the same concurrency group.

name: Deployment

concurrency: 
  group: production
  cancel-in-progress: true

on:
  push:
    branches:
      - main

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

Viewing deployment history

When a GitHub Actions workflow deploys to an environment, the environment is displayed on the main page of the repository. For more information about viewing deployments to environments, see "Viewing deployment history."

Monitoring workflow runs

Every workflow run generates a real-time graph that illustrates the run progress. You can use this graph to monitor and debug deployments. For more information see, "Using the visualization graph."

You can also view the logs of each workflow run and the history of workflow runs. For more information, see "Viewing workflow run history."

Tracking deployments through apps

You can also build an app that uses deployment and deployment status webhooks to track deployments. 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. For more information, see "Apps" and "Webhook events and payloads."

Displaying a status badge

You can use a status badge to display the status of your deployment workflow. Um selo de status mostra se um fluxo de trabalho está falhando ou passando. Um lugar comum para adicionar um selo de status é o arquivo README.md do seu repositório, mas você pode adicioná-lo a qualquer página da web que desejar. Por padrão, os selos exibem o status do seu branch-padrão. Também é possível exibir o status de uma execução de fluxo de trabalho para um branch ou evento específico usando os parâmetros de consulta do branch e evento na URL.

exemplo de selo de status

For more information, see "Adding a workflow status badge."

Next steps

This article demonstrated features of GitHub Actions that you can add to your deployment workflows.

GitHub AE oferece modelos de CD para vários serviços populares, como o Azure Web App. Para aprender como começar a usar um modelo de fluxo de trabalho, consulte "Usando modelos de fluxo de trabalho" ou pesquise a lista completa dos modelos de fluxo de implantação. Você também pode conferir nossos guias mais detalhados de fluxos de trabalho específicos para implantação como, por exemplo, "Efetuando a implantação no Azure App Service".

Muitos prestadores de serviço também oferecem ações em GitHub Marketplace para implantar no seu serviço. Para a lista completa, consulte GitHub Marketplace.

Esse documento ajudou você?

Política de Privacidade

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.