Skip to main content

Esta versão do GitHub Enterprise será descontinuada em 2023-01-18. Nenhum lançamento de patch será feito, mesmo para questões críticas de segurança. Para obter melhor desempenho, segurança aprimorada e novos recursos, atualize para a última versão do GitHub Enterprise. Para obter ajuda com a atualização, entre em contato com o suporte do GitHub Enterprise.

Comandos de fluxo de trabalho para o GitHub Actions

Você pode usar comandos do fluxo de trabalho ao executar comandos do shell em um fluxo de trabalho ou no código de uma ação.

Observação: no momento, não há suporte para os executores hospedados no GitHub no GitHub Enterprise Server. Você pode ver mais informações sobre o suporte futuro planejado no GitHub public roadmap.

Sobre os comandos do fluxo de trabalho

As ações podem comunicar-se com a máquina do executor para definir as variáveis de ambiente, valores de saída usados por outras ações, adicionar mensagens de depuração aos registros de saída e outras tarefas.

A maioria dos comandos do fluxo de trabalho usa o comando echo em um formato específico, enquanto outros são chamados pela gravação em um arquivo. Para obter mais informações, confira Arquivos de ambiente.

Exemplo

Shell
echo "::workflow-command parameter1={data},parameter2={data}::{command value}"
pwsh
Write-Output "::workflow-command parameter1={data},parameter2={data}::{command value}"

Observação: os nomes de parâmetros e de comandos do fluxo de trabalho não diferenciam maiúsculas e minúsculas.

Aviso: se você estiver usando um prompt de comando, omita os caracteres de aspas duplas " ao usar comandos do fluxo de trabalho.

Usar comandos do fluxo de trabalho para acessar funções do kit de de ferramentas

O actions/toolkit inclui várias funções que podem ser executadas como comandos do fluxo de trabalho. Use a sintaxe :: para executar os comandos do fluxo de trabalho no arquivo YAML. Em seguida, esses comandos são enviados ao executor por meio do stdout. Por exemplo, em vez de usar o código para definir uma saída, como abaixo:

JavaScript
core.setOutput('SELECTED_COLOR', 'green');

Exemplo: definição de um valor

Use o comando set-output no fluxo de trabalho para definir o mesmo valor:

YAML
      - name: Set selected color
        run: echo '::set-output name=SELECTED_COLOR::green'
        id: random-color-generator
      - name: Get color
        run: echo "The selected color is ${{ steps.random-color-generator.outputs.SELECTED_COLOR }}"
YAML
      - name: Set selected color
        run: Write-Output "::set-output name=SELECTED_COLOR::green"
        id: random-color-generator
      - name: Get color
        run: Write-Output "The selected color is ${{ steps.random-color-generator.outputs.SELECTED_COLOR }}"

A tabela a seguir mostra quais funções do conjunto de ferramentas estão disponíveis dentro de um fluxo de trabalho:

Função do kit de ferramentasComando equivalente do fluxo de trabalho
core.addPathAcessível por meio do arquivo de ambiente GITHUB_PATH
core.debugdebug
core.noticenotice
core.errorerror
core.endGroupendgroup
core.exportVariableAcessível por meio do arquivo de ambiente GITHUB_ENV
core.getInputAcessível por meio da variável de ambiente INPUT_{NAME}
core.getStateAcessível por meio da variável de ambiente STATE_{NAME}
core.isDebugAcessível por meio da variável de ambiente RUNNER_DEBUG

Definir um parâmetro de saída

Configura um parâmetro de saída da ação.

Code
::set-output name={name}::{value}

Opcionalmente, você também pode declarar os parâmetros de saída no arquivo de metadados de uma ação. Para obter mais informações, confira "Sintaxe de metadados do GitHub Actions".

Você pode usar escape em cadeias de caracteres multilinha para definir um parâmetro de saída criando uma variável de ambiente a ser usada em um comando de fluxo de trabalho. Para obter mais informações, confira "Como configurar uma variável de ambiente".

Exemplo: definição de um parâmetro de saída

Shell
echo "::set-output name=action_fruit::strawberry"
pwsh
Write-Output "::set-output name=action_fruit::strawberry"

Configurar uma mensagem de depuração

Imprime uma mensagem de erro no log. Você precisa criar um segredo chamado ACTIONS_STEP_DEBUG com o valor true para ver as mensagens de depuração definidas por esse comando no log. Para obter mais informações, confira "Como habilitar o log de depuração".

Code
::debug::{message}

Exemplo: definição de uma mensagem de depuração

Shell
echo "::debug::Set the Octocat variable"
pwsh
Write-Output "::debug::Set the Octocat variable"

Configurando uma mensagem de aviso

Cria uma mensagem de aviso e a imprime no registro. Esta mensagem criará uma anotação, que pode associar a mensagem a um arquivo em particular no repositório. Opcionalmente, sua mensagem pode especificar uma posição dentro do arquivo.

Code
::notice file={name},line={line},endLine={endLine},title={title}::{message}
ParâmetroValor
titleTítulo personalizado
fileNome de arquivo
colNúmero da coluna, começando em 1
endColumnNúmero final da coluna
lineNúmero de linha, começando em 1
endLineNúmero final da linha

Exemplo: definição de uma mensagem de aviso

Shell
echo "::notice file=app.js,line=1,col=5,endColumn=7::Missing semicolon"
pwsh
Write-Output "::notice file=app.js,line=1,col=5,endColumn=7::Missing semicolon"

Configurar uma mensagem de aviso

Cria uma mensagem de aviso e a imprime no log. Esta mensagem criará uma anotação, que pode associar a mensagem a um arquivo em particular no repositório. Opcionalmente, sua mensagem pode especificar uma posição dentro do arquivo.

Code
::warning file={name},line={line},endLine={endLine},title={title}::{message}
ParâmetroValor
titleTítulo personalizado
fileNome de arquivo
colNúmero da coluna, começando em 1
endColumnNúmero final da coluna
lineNúmero de linha, começando em 1
endLineNúmero final da linha

Exemplo: definição de uma mensagem de aviso

Shell
echo "::warning file=app.js,line=1,col=5,endColumn=7::Missing semicolon"
pwsh
Write-Output "::warning file=app.js,line=1,col=5,endColumn=7::Missing semicolon"

Configurar uma mensagem de erro

Cria uma mensagem de erro e a imprime no log. Esta mensagem criará uma anotação, que pode associar a mensagem a um arquivo em particular no repositório. Opcionalmente, sua mensagem pode especificar uma posição dentro do arquivo.

Code
::error file={name},line={line},endLine={endLine},title={title}::{message}
ParâmetroValor
titleTítulo personalizado
fileNome de arquivo
colNúmero da coluna, começando em 1
endColumnNúmero final da coluna
lineNúmero de linha, começando em 1
endLineNúmero final da linha

Exemplo: definição de uma mensagem de erro

Shell
echo "::error file=app.js,line=1,col=5,endColumn=7::Missing semicolon"
pwsh
Write-Output "::error file=app.js,line=1,col=5,endColumn=7::Missing semicolon"

Agrupar linhas dos registros

Cria um grupo expansível no registro. Para criar um grupo, use o comando group e especifique um title. Qualquer coisa que você imprimir no log entre os comandos group e endgroup estará aninhada dentro de uma entrada expansível no log.

Code
::group::{title}
::endgroup::

Exemplo: agrupamento de linhas de log

YAML
jobs:
  bash-example:
    runs-on: ubuntu-latest
    steps:
      - name: Group of log lines
        run: |
            echo "::group::My title"
            echo "Inside group"
            echo "::endgroup::"
YAML
jobs:
  powershell-example:
    runs-on: windows-latest
    steps:
      - name: Group of log lines
        run: |
            Write-Output "::group::My title"
            Write-Output "Inside group"
            Write-Output "::endgroup::"

Grupo dobrável no registro da execução do fluxo de trabalho

Mascarar um valor no registro

Code
::add-mask::{value}

Mascarar um valor evita que uma string ou variável seja impressa no log. Cada palavra mascarada separada por um espaço em branco é substituída pelo caractere *. Use uma variável de ambiente ou uma cadeia de caracteres para o value da máscara. Quando você mascara um valor, ele é tratado como um segredo e será redigido no executor. Por exemplo, depois de mascarar um valor, você não poderá definir esse valor como uma saída.

Exemplo: mascaramento de uma cadeia de caracteres

Ao imprimir "Mona The Octocat" no log, você verá "***".

Shell
echo "::add-mask::Mona The Octocat"
pwsh
Write-Output "::add-mask::Mona The Octocat"

Aviso: registre o segredo com "add-mask" antes de enviá-lo aos logs de build ou usá-lo em comandos de outro fluxo de trabalho.

Exemplo: mascaramento de uma variável de ambiente

Ao imprimir a variável MY_NAME ou o valor "Mona The Octocat" no log, você verá "***" em vez de "Mona The Octocat".

YAML
jobs:
  bash-example:
    runs-on: ubuntu-latest
    env:
      MY_NAME: "Mona The Octocat"
    steps:
      - name: bash-version
        run: echo "::add-mask::$MY_NAME"
YAML
jobs:
  powershell-example:
    runs-on: windows-latest
    env:
      MY_NAME: "Mona The Octocat"
    steps:
      - name: powershell-version
        run: Write-Output "::add-mask::$env:MY_NAME"

Parar e iniciar os comandos no fluxo de trabalho

Para de processar quaisquer comandos de fluxo de trabalho. Esse comando especial permite fazer o registro do que você desejar sem executar um comando do fluxo de trabalho acidentalmente. Por exemplo, é possível parar o log para gerar um script inteiro que tenha comentários.

Code
::stop-commands::{endtoken}

Para interromper o processamento de comandos do fluxo de trabalho, transmita um token único para stop-commands. Para retomar os comandos do fluxo de trabalho, passe o mesmo token que você usou para parar os comandos do fluxo de trabalho.

Aviso: verifique se que o token que você está usando é gerado aleatoriamente e exclusivo para cada execução.

Code
::{endtoken}::

Exemplo: interrupção e inicialização de comandos do fluxo de trabalho

YAML
jobs:
  workflow-command-job:
    runs-on: ubuntu-latest
    steps:
      - name: Disable workflow commands
        run: |
          echo '::warning:: This is a warning message, to demonstrate that commands are being processed.'
          stopMarker=$(uuidgen)
          echo "::stop-commands::$stopMarker"
          echo '::warning:: This will NOT be rendered as a warning, because stop-commands has been invoked.'
          echo "::$stopMarker::"
          echo '::warning:: This is a warning again, because stop-commands has been turned off.'
YAML
jobs:
  workflow-command-job:
    runs-on: windows-latest
    steps:
      - name: Disable workflow commands
        run: |
          Write-Output '::warning:: This is a warning message, to demonstrate that commands are being processed.'
          $stopMarker = New-Guid
          Write-Output "::stop-commands::$stopMarker"
          Write-Output '::warning:: This will NOT be rendered as a warning, because stop-commands has been invoked.'
          Write-Output "::$stopMarker::"
          Write-Output '::warning:: This is a warning again, because stop-commands has been turned off.'

Eco de saídas de comando

Habilita ou desabilita o eco de comandos de fluxo de trabalho. Por exemplo, se você usar o comando set-output em um fluxo de trabalho, ele definirá um parâmetro de saída, mas o log da execução de fluxo de trabalho não mostrará o comando em si. Se você habilitar o retorno de comando, o log mostrará o comando, como ::set-output name={name}::{value}.

Code
::echo::on
::echo::off

O eco de comandos encontra-se desabilitado por padrão. No entanto, um comando de fluxo de trabalho será refletido se houver algum erro que processa o comando.

Os comandos add-mask, debug, warning e error não dão suporte ao retorno porque as saídas já foram retornadas ao log.

Você também pode habilitar o comando de retorno globalmente ativando o log de depuração da etapa usando o segredo ACTIONS_STEP_DEBUG. Para obter mais informações, confira "Como habilitar o log de depuração". Por outro lado, o comando do fluxo de trabalho echo permite que você habilite o comando de retorno em um nível mais granular, em vez de habilitá-lo para cada fluxo de trabalho em um repositório.

Exemplo: alternância do comando de retorno

YAML
jobs:
  workflow-command-job:
    runs-on: ubuntu-latest
    steps:
      - name: toggle workflow command echoing
        run: |
          echo '::set-output name=action_echo::disabled'
          echo '::echo::on'
          echo '::set-output name=action_echo::enabled'
          echo '::echo::off'
          echo '::set-output name=action_echo::disabled'
YAML
jobs:
  workflow-command-job:
    runs-on: windows-latest
    steps:
      - name: toggle workflow command echoing
        run: |
          write-output "::set-output name=action_echo::disabled"
          write-output "::echo::on"
          write-output "::set-output name=action_echo::enabled"
          write-output "::echo::off"
          write-output "::set-output name=action_echo::disabled"

O exemplo acima imprime as seguintes linhas no log:

Code
::set-output name=action_echo::enabled
::echo::off

Apenas os comandos do fluxo de trabalho set-output e echo são incluídos no log, porque o retorno de comando só estava habilitado quando eles foram executados. Mesmo que nem sempre ele esteja ecoado, o parâmetro de saída é definido em todos os casos.

Enviar valores para as ações anterior e posterior

Você pode usar o comando save-state para criar variáveis de ambiente a serem compartilhadas com as ações pre: ou post: do fluxo de trabalho. Por exemplo, você pode criar um arquivo com a ação pre:, transmitir a localização do arquivo para a ação main: e usar a ação post: para excluir o arquivo. Como alternativa, você pode criar um arquivo com a ação main:, transmitir a localização do arquivo para a ação post: e usar a ação post: para excluir o arquivo.

Se você tiver várias ações pre: ou post:, só poderá acessar o valor salvo na ação em que save-state ele foi usado. Para obter mais informações sobre a ação post:, confira "Sintaxe de metadados do GitHub Actions".

O comando save-state só pode ser executado em uma ação e não está disponível para arquivos YAML. O valor salvo é armazenado como um valor de ambiente com o prefixo STATE_.

Este exemplo usa JavaScript para executar o comando save-state. A variável de ambiente resultante é chamada STATE_processID com o valor de 12345:

JavaScript
console.log('::save-state name=processID::12345')

Em seguida, a variável STATE_processID fica disponível exclusivamente para o script de limpeza em execução na ação main. Este exemplo é executado em main e usa o JavaScript para exibir o valor atribuído à variável de ambiente STATE_processID:

JavaScript
console.log("The running PID from the main action is: " +  process.env.STATE_processID);

Arquivos de ambiente

Durante a execução de um fluxo de trabalho, o executor gera arquivos temporários que podem ser usados para executar certas ações. O caminho para esses arquivos são expostos através de variáveis de ambiente. Você precisará usar a codificação UTF-8 ao escrever para esses arquivos para garantir o processamento adequado dos comandos. Vários comandos podem ser escritos no mesmo arquivo, separados por novas linhas.

A maioria dos comandos nos exemplos a seguir usa aspas duplas para ecoar cadeias de caracteres, que tentarão interpolar caracteres como $ para nomes de variáveis de shell. Para sempre usar valores literais em cadeias de caracteres entre aspas, você poderá usar aspas simples.

Observação: as versões 5.1 e inferior do PowerShell (shell: powershell) não usam UTF-8 por padrão, ou seja, você precisa especificar a codificação UTF-8. Por exemplo:

YAML
jobs:
  legacy-powershell-example:
    runs-on: windows-latest
    steps:
      - shell: powershell
        run: |
          "mypath" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append

As versões 6 e superior do PowerShell Core (shell: pwsh) usam UTF-8 por padrão. Por exemplo:

YAML
jobs:
  powershell-core-example:
    runs-on: windows-latest
    steps:
      - shell: pwsh
        run: |
          "mypath" >> $env:GITHUB_PATH

Configurar uma variável de ambiente

Shell
echo "{environment_variable_name}={value}" >> $GITHUB_ENV
  • Como usar o PowerShell versão 6 e superior:

    pwsh
    "{environment_variable_name}={value}" >> $env:GITHUB_ENV
  • Como usar o PowerShell versão 5.1 e inferior:

    powershell
    "{environment_variable_name}={value}" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append

Disponibilize uma variável de ambiente para todas as etapas posteriores em um trabalho de fluxo de trabalho definindo ou atualizando a variável de ambiente e gravando isso no arquivo de ambiente GITHUB_ENV. A etapa que cria ou atualiza a variável de ambiente não tem acesso ao novo valor, mas todos os passos subsequentes em um trabalho terão acesso. Os nomes das variáveis de ambiente são diferenciam maiúsculas e minúsculas e você pode incluir a pontuação. Para obter mais informações, confira "Variáveis de ambiente".

Exemplo

YAML
steps:
  - name: Set the value
    id: step_one
    run: |
      echo "action_state=yellow" >> $GITHUB_ENV
  - name: Use the value
    id: step_two
    run: |
      echo "${{ env.action_state }}" # This will output 'yellow'
YAML
steps:
  - name: Set the value
    id: step_one
    run: |
      "action_state=yellow" >> $env:GITHUB_ENV
  - name: Use the value
    id: step_two
    run: |
      Write-Output "${{ env.action_state }}" # This will output 'yellow'

Strings de linha múltipla

Para strings linha múltipla, você pode usar um delimitador com a seguinte sintaxe.

Code
{name}<<{delimiter}
{value}
{delimiter}

Aviso: verifique se que o delimitador que você está usando é gerado aleatoriamente e exclusivo para cada execução. Para obter mais informações, confira "Noções básicas sobre o risco de injeções de script".

Exemplo

Este exemplo usa EOF como delimitador e define a variável de ambiente JSON_RESPONSE como o valor da resposta curl.

YAML
steps:
  - name: Set the value in bash
    id: step_one
    run: |
      echo 'JSON_RESPONSE<<EOF' >> $GITHUB_ENV
      curl https://example.com >> $GITHUB_ENV
      echo 'EOF' >> $GITHUB_ENV
YAML
steps:
  - name: Set the value in pwsh
    id: step_one
    run: |
      "JSON_RESPONSE<<EOF" >> $env:GITHUB_ENV
      (Invoke-WebRequest -Uri "https://example.com").Content >> $env:GITHUB_ENV
      "EOF" >> $env:GITHUB_ENV
    shell: pwsh

Adicionar um caminho do sistema

Insere um diretório antes da variável PATH do sistema e o disponibiliza automaticamente para todas as ações posteriores do trabalho atual. A ação atualmente em execução não pode acessar a variável de caminho atualizada. Para ver os caminhos atualmente definidos para seu trabalho, use echo "$PATH" em uma etapa ou uma ação.

Shell
echo "{path}" >> $GITHUB_PATH
pwsh
"{path}" >> $env:GITHUB_PATH

Exemplo

Este exemplo demonstra como adicionar o diretório $HOME/.local/bin do usuário a PATH:

Shell
echo "$HOME/.local/bin" >> $GITHUB_PATH

Este exemplo demonstra como adicionar o diretório $env:HOMEPATH/.local/bin do usuário a PATH:

pwsh
"$env:HOMEPATH/.local/bin" >> $env:GITHUB_PATH