Skip to main content

Команды рабочего процесса для GitHub Actions

При выполнении команд оболочки в рабочем процессе или в коде действия можно использовать команды рабочего процесса.

Tool navigation

Примечание.

GitHubразмещенные в данный момент средства выполнения не поддерживаются в GitHub Enterprise Server. Дополнительные сведения о планируемой поддержке в будущем см. в GitHub public roadmap.

Общие сведения о командах рабочего процесса

GitHub Actions могут связываться с компьютером выполнения, чтобы задавать переменные среды, выводить значения, используемые другими действиями, добавлять сообщения отладки в журналы выходных данных и выполнять другие задачи.

Большинство команд рабочего процесса используют команду echo в определенном формате, остальные вызываются путем записи в файл. Дополнительные сведения см. в разделе Файлы среды.

Пример команды рабочего процесса

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

Примечание.

Команды рабочего процесса и имена параметров не учитывает регистр.

Предупреждение

Если вы используете командную строку, не указывайте двойные кавычки (") при использовании команд рабочего процесса.

Использование команд рабочего процесса для доступа к возможностям набора средств

В actions/toolkit содержится ряд функций, которые можно выполнять как команды рабочего процесса. Используйте синтаксис ::, чтобы выполнить команды рабочего процесса в файле YAML. Затем они отправляются в средство выполнения через stdout.

Например, вместо использования кода для создания заметки об ошибке, как показано ниже:

JavaScript
core.error('Missing semicolon', {file: 'app.js', startLine: 1})

Пример. Создание заметки для ошибки

Чтобы создать ту же заметку об ошибках, можно использовать error команду в рабочем процессе:

YAML
      - name: Create annotation for build error
        run: echo "::error file=app.js,line=1::Missing semicolon"
YAML
      - name: Create annotation for build error
        run: Write-Output "::error file=app.js,line=1::Missing semicolon"

В следующей таблице перечислены функции набора средств, которые доступны в рабочем процессе:

Функция набора средствАналогичная команда рабочего процесса
core.addPathДоступно с помощью файла среды GITHUB_PATH
core.debugdebug
core.noticenotice
core.errorerror
core.endGroupendgroup
core.exportVariableДоступно с помощью файла среды GITHUB_ENV
core.getInputДоступно с помощью переменной среды INPUT_{NAME}
core.getStateДоступно с помощью переменной среды STATE_{NAME}
core.isDebugДоступно с помощью переменной среды RUNNER_DEBUG
core.summaryДоступно с помощью файла среды GITHUB_STEP_SUMMARY
core.saveStateДоступно с помощью файла среды GITHUB_STATE
core.setCommandEchoecho
core.setFailedИспользуется в качестве ярлыка для ::error и exit 1
core.setOutputДоступно с помощью файла среды GITHUB_OUTPUT
core.setSecretadd-mask
core.startGroupgroup
core.warningwarning

Задание сообщения отладки

Записывает сообщение отладки в журнал. Чтобы просмотреть в журнале сообщения отладки, заданные этой командой, необходимо создать секрет под названием ACTIONS_STEP_DEBUG со значением true. Дополнительные сведения см. в разделе Включение ведения журналов отладки.

Text
::debug::{message}

Пример: задание сообщения отладки

Bash
echo "::debug::Set the Octocat variable"
PowerShell
Write-Output "::debug::Set the Octocat variable"

Задание сообщения уведомления

Создает сообщение уведомления и записывает его в журнал. Это сообщение создаст заметку, которая может связать его с определенным файлом в репозитории. При необходимости сообщение может указать позицию в файле.

Text
::notice file={name},line={line},endLine={endLine},title={title}::{message}
ПараметрЗначениеОбязательное полеПо умолчанию.
titleНастраиваемый заголовокNoнет
fileИмя файлаNo.github
colНомер столбца, начиная с 1Noнет
endColumnНомер конечного столбцаNoнет
lineНомер строки, начиная с 1No1
endLineНомер конечной строкиNo1