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 um fluxo de trabalho, usando as palavras-chave jobs.<job_id>.steps[*].env, jobs.<job_id>.env, and env. Para obter mais informações, consulte "Sintaxe de fluxo de trabalho para o GitHub".
passos:
- nome: Olá mundo
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 arquivo de ambiente GITHUB_ENV para definir uma variável de ambiente que as seguintes etapas em um fluxo de trabalho podem usar. O arquivo de ambiente pode ser usado diretamente por uma ação ou como um comando de shell em um arquivo de fluxo de trabalho usando a palavra-chave 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 ambiente | Descrição |
|---|---|
CI | Definido sempre como verdadeiro. |
GITHUB_WORKFLOW | Nome do fluxo de trabalho. |
GITHUB_RUN_ID | Um 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_NUMBER | Um 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_ACTION | Identificador único (id) da ação. |
GITHUB_ACTIONS | Definido 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_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 de área de trabalho é uma cópia do repositório se o fluxo de trabalho usar 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 | Definir somente para eventos de pull request. O nome do branch principal. |
GITHUB_BASE_REF | Definir somente para eventos de pull request. O nome do branch de base. |
GITHUB_SERVER_URL | Retorna a URL do servidor GitHub. Por exemplo: https://github.com. |
GITHUB_API_URL | Retorna a URL da API. Por exemplo: https://api.github.com. |
GITHUB_GRAPHQL_URL | Retorna 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.