Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais recentes, acesse a documentação em inglês. Se houver problemas com a tradução desta página, entre em contato conosco.

Usar variáveis de ambiente

GitHub define as variáveis do ambiente para cada execução do fluxo de trabalho GitHub Actions. Você também pode definir variáveis de ambiente personalizadas no seu arquivo do fluxo de trabalho.

GitHub Actions está disponível com GitHub Free, GitHub Pro, GitHub Free para organizações, GitHub Team, GitHub Enterprise Cloud e GitHub One. O GitHub Actions não está disponível para repositórios privados de contas que utilizam planos antigos por-repositório. Para obter mais informações, consulte os "produtos do GitHub".

Neste artigo

Sobre as variáveis de ambiente

GitHub define as variáveis-padrão do ambiente disponíveis para cada etapa da execução de um fluxo de trabalho. As variáveis de ambiente diferenciam entre maiúsculas e minúsculas. Os comandos executados em ações ou etapas podem criar, ler e modificar as variáveis do ambiente.

Para definir as variáveis do ambiente personalizadas, você deverá especificar as variáveis no arquivo do fluxo de trabalho. Você pode definir as variáveis de ambiente para uma etapa, trabalho ou para todo o fluxo de trabalho usando as palavras-chave jobs.<job_id>.steps.env, jobs.<job_id>.env, e env. Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o GitHub".

steps:
  - name: Hello world
    run: echo Hello world $FIRST_NAME $middle_name $Last_Name!
    env:
      FIRST_NAME: Mona
      middle_name: The
      Last_Name: Octocat

Você também pode usar o comando do fluxo de trabalho set-env para definir uma variável de ambiente que as etapas a seguir podem usar em um fluxo de trabalho. O comando set-env pode ser usado diretamente por outra ação ou como um comando do shell em um arquivo do fluxo de trabalho usando a palavra-chave executar executar. Para obter mais informações, consulte "Comandos do fluxo de trabalho para GitHub Actions".

Variáveis padrão de ambiente

É altamente recomendável que as ações usem as variáveis do ambiente para acessar o sistema do arquivo em vez de usar os caminhos do arquivo com codificação rígida. GitHub define as variáveis de ambiente para ações a serem usadas em todos os ambientes executores.

Variável de ambienteDescrição
CIDefinido sempre como verdadeiro.
HOMECaminho para o diretório inicial do GitHub usado para armazenar dados do usuário. Por exemplo, /github/home.
GITHUB_WORKFLOWNome do fluxo de trabalho.
GITHUB_RUN_IDUm número exclusivo para cada execução em um repositório. Este número não muda se você executar novamente o fluxo de trabalho.
GITHUB_RUN_NUMBERUm número exclusivo para cada execução de um fluxo de trabalho específico em um repositório. Este número começa em 1 para a primeira execução do fluxo de trabalho, e incrementa a cada nova execução. Este número não muda se você executar novamente o fluxo de trabalho.
GITHUB_ACTIONIdentificador único (id) da ação.
GITHUB_ACTIONSDefinido sempre como verdadeiro quando GitHub Actions estiver executando o fluxo de trabalho. Você pode usar esta variável para diferenciar quando os testes estão sendo executados localmente ou por GitHub Actions.
GITHUB_ACTORNome da pessoa ou aplicativo que iniciou o fluxo de trabalho. Por exemplo, octocat.
GITHUB_REPOSITORYNome do repositório e o proprietário. Por exemplo, octocat/Hello-World.
GITHUB_EVENT_NAMENome do evento de webhook que acionou o workflow.
GITHUB_EVENT_PATHCaminho do arquivo com a carga completa do evento webhook. Por exemplo, /github/workflow/event.json.
GITHUB_WORKSPACECaminho do diretório do espaço de trabalho do GitHub. O diretório espaço de trabalho contém um subdiretório com uma cópia do repositório, caso o seu fluxo de trabalho utilize a ação actions/checkout. Se você não usar a ação actions/checkout, o diretório estará vazio. Por exemplo, /home/runner/work/my-repo-name/my-repo-name.
GITHUB_SHACommit SHA que acionou o fluxo de trabalho. Por exemplo, ffac537e6cbbf934b08745a378932722df287a53.
GITHUB_REFBranch ou ref tag que acionou o fluxo de trabalho. Por exemplo, refs/heads/feature-branch-1. Se não houver branch ou tag disponível para o tipo de evento, a variável não existirá.
GITHUB_HEAD_REFConfigurado somente para repositórios bifurcados. O branch do repositório head.
GITHUB_BASE_REFConfigurado somente para repositórios bifurcados. O branch do repositório base.
GITHUB_SERVER_URLRetorna a URL do servidor GitHub. Por exemplo: https://github.com.
GITHUB_API_URLRetorna a URL da API. Por exemplo: https://api.github.com.
GITHUB_GRAPHQL_URLRetorna a URL API do GraphQL. Por exemplo: https://api.github.com/graphql.

Convenções de nomenclatura para variáveis de ambiente

ObservaçãoGitHub reserva o prefixo da variável de ambiente GITHUB_ para uso interno por GitHub. Definir uma variável de ambiente ou segredo com o prefixo GITHUB_ resultará em erro.

Qualquer variável de ambiente nova que você definir e apontar para um local no sistema de arquivos deve ter um sufixo _PATH. As variáveis padrão HOME e GITHUB_WORKSPACE são exceções a essa convenção porque as palavras "inicial" e "espaço de trabalho" já indicam o local.

Pergunte a uma pessoa

Não consegue encontrar o que procura?

Entrar em contato