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.

Using environment variables

GitHub sets default environment variables for each GitHub Actions workflow run, but you can also set custom environment variables in your workflow file.

GitHub Actions is available with GitHub Free, GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. GitHub Actions is unavailable for per-repository plans, which are legacy billing plans. For more information, see "GitHub's products."

Neste artigo

About environment variables

GitHub sets default environment variables that are available to every step in a workflow run. Environment variables are case-sensitive. Commands run in actions or steps can create, read, and modify environment variables.

To set custom environment variables, you need to specify the variables in the workflow file. You can define environment variables for a step, job, or entire workflow using the jobs.<job_id>.steps.env, jobs.<job_id>.env, and env keywords. 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

Variáveis padrão de ambiente

We strongly recommend that actions use environment variables to access the filesystem rather than using hardcoded file paths. O GitHub define variáveis de ambiente para ações a serem usadas em todos os ambientes virtuais.

Variável de ambiente Descrição
HOME Caminho para o diretório inicial do GitHub usado para armazenar dados do usuário. Por exemplo, /github/home.
GITHUB_WORKFLOW Nome do fluxo de trabalho.
GITHUB_ACTION Identificador único (id) da ação.
GITHUB_ACTIONS Always set to true when GitHub Actions is running the workflow. You can use this variable to differentiate when tests are being run locally or by GitHub Actions.
GITHUB_ACTOR Nome da pessoa ou aplicativo que iniciou o fluxo de trabalho. Por exemplo, octocat.
GITHUB_REPOSITORY Nome do repositório e o proprietário. Por exemplo, octocat/Hello-World.
GITHUB_EVENT_NAME Nome do evento de webhook que acionou o workflow.
GITHUB_EVENT_PATH Caminho do arquivo com a carga completa do evento webhook. Por exemplo, /github/workflow/event.json.
GITHUB_WORKSPACE Caminho 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_SHA Commit SHA que acionou o fluxo de trabalho. Por exemplo, ffac537e6cbbf934b08745a378932722df287a53.
GITHUB_REF Branch 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_REF Configurado somente para repositórios bifurcados. O branch do repositório head.
GITHUB_BASE_REF Configurado somente para repositórios bifurcados. O branch do repositório base.

Naming conventions for environment variables

Observação: o GitHub reserva o prefixo da variável de ambiente GITHUB_ para uso interno pelo 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