Настройка кодов выхода для действий – Документация GitHub Enterprise Server 39

Когда вы публикуете действие на GitHub Marketplace, пользователи могут интегрировать его в свои репозитории и использовать его в своих рабочих процессах. Один из важных аспектов при разработке и поддержке действий – это определение кодов выхода, которые указывают на успешное выполнение или возникновение ошибки во время выполнения действия. В этой статье мы рассмотрим, как настроить коды выхода для ваших действий.

Код выхода – это целочисленное значение, которое возвращает действие в конце своего выполнения. Код 0 обычно указывает на успешное выполнение действия, в то время как ненулевые значения обычно указывают на ошибку. На GitHub Enterprise Server 39 вы можете настроить эти коды выхода, чтобы контролировать поведение действий и уведомлять пользователей о возникших проблемах.

Контроль кодов выхода позволяет вам точно определить, когда действие выполнилось успешно, а когда произошла ошибка. Это важно для автоматизации рабочих процессов и уведомления пользователей о возникших проблемах. Настройка кодов выхода – это одна из ключевых задач при разработке и поддержке действий на GitHub Marketplace.

Чтобы настроить коды выхода для своего действия, вам необходимо определить их в файле сценария вашего действия. Вы можете использовать инструкцию exit, чтобы указать возвращаемое значение. Например, вы можете использовать следующий код, чтобы указать успешное выполнение действия с кодом 0:

Настройка кодов выхода для действий

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

По умолчанию, действия возвращают код выхода 0, что означает успешное выполнение. Однако вы можете настроить коды выхода с помощью переменной окружения GITHUB_ACTION_EXIT_CODE.

Чтобы настроить код выхода, вам нужно добавить следующую строку в свой файл сценария действия:

echo "::set-env name=GITHUB_ACTION_EXIT_CODE::1"

В приведенном выше примере код выхода устанавливается равным 1. Вы можете выбрать любой другой код в соответствии с вашими потребностями.

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

Настройка кодов выхода для действий может быть полезна для определения степени успешности или необходимости предпринятия дополнительных действий на основе результата выполнения действия.

Использование корректных кодов выхода помогает упростить процесс автоматизации и сократить время на обработку результатов действий.

GitHub Enterprise Server 3.9

GitHub Enterprise Server 3.9 предоставляет вам всю необходимую функциональность для эффективного сотрудничества и управления проектами в вашей команде. Обновитесь до новой версии сегодня и опробуйте все возможности, которые мы добавили!

Действия и их коды выхода

В GitHub Enterprise Server 3.9 действия представляют собой автоматические процессы, которые выполняют определенные задачи в вашем репозитории или организации. Каждое действие может завершиться с определенным кодом выхода, который указывает на результат выполнения действия.

Коды выхода помогают понять, было ли выполнено действие успешно или возникли ошибки. Обычно код 0 означает успешное выполнение, а любое другое значение указывает на ошибку или проблему в процессе.

Ниже представлены некоторые распространенные действия и их коды выхода:

• Клонирование репозитория: Код выхода 0 обычно означает успешное клонирование репозитория.

• Создание ветки: Код выхода 0 означает успешное создание ветки, а другие значения могут указывать на ошибки в процессе.

• Публикация релиза: Код выхода 0 обычно означает успешную публикацию релиза.

• Выполнение тестов: Коды выхода могут указывать на успешное или неуспешное выполнение тестов, в зависимости от результатов тестирования.

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

Корректное использование кодов выхода поможет вам отслеживать и устранять ошибки в ваших действиях, а также повысит эффективность ваших автоматических процессов.

Получение списка действий

Получение списка действий позволяет получить информацию о всех доступных действиях в рамках настройки кодов выхода.

Чтобы получить список действий, выполните следующий запрос:

• Метод: GET
• URL: /actions

Ответ на запрос будет содержать список всех доступных действий с их кодами выхода.

Пример ответа:

{
"actions": [
{
"name": "create_repository",
"exit_codes": [
0,
1
]
},
{
"name": "delete_branch",
"exit_codes": [
0,
1,
128
]
},
{
"name": "merge_branches",
"exit_codes": [
0,
1,
128,
256
]
}
]
}

В данном примере показан список трех доступных действий: create_repository, delete_branch и merge_branches. Каждое действие имеет свои коды выхода, которые могут быть возвращены при выполнении соответствующего действия. Например, действие create_repository может вернуть коды выхода 0 и 1, а действие merge_branches может вернуть коды выхода 0, 1, 128 и 256.

Объявление кодов выхода

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

При объявлении кодов выхода важно учесть, что значение 0 обычно означает успешное выполнение действия, а все остальные значения сигнализируют о наличии ошибок.

Коды выхода обычно разделяют на категории:

• 0-127: коды выхода, определенные операционной системой;
• 128-255: коды выхода, определенные пользователем.

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

В документации рекомендуется использовать таблицу для представления кодов выхода. Формат таблицы может быть следующим:

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

Установка кодов выхода для действий

Чтобы установить коды выхода для действий, выполните следующие шаги:

1. Откройте репозиторий на GitHub Enterprise Server.
2. Перейдите во вкладку “Actions” (Действия).
3. Выберите нужное действие из списка действий.
4. Нажмите на кнопку “Edit” (Редактировать) в верхнем правом углу.
5. Найдите секцию “Outcome Codes” (Коды исхода).
6. Укажите желаемые коды выхода в поле “Exit Codes” (Коды выхода).
7. Нажмите на кнопку “Save” (Сохранить) для применения изменений.

После установки кодов выхода, действие будет использовать указанные коды выхода при завершении выполнения. Если действие завершилось успешно, можно использовать код выхода 0. В противном случае, можно использовать другие значения для указания возникших проблем.

Коды выхода действий могут быть использованы другими действиями или скриптами для принятия соответствующих действий на основе результатов выполнения. Это помогает автоматизировать процессы в вашем репозитории и обеспечивает более гибкое управление действиями.

Преимущества настройки кодов выхода

Настройка кодов выхода для действий в GitHub Enterprise Server обладает несколькими преимуществами, которые помогут оптимизировать и улучшить процесс работы:

Определение результатов выполнения действий

При выполнении действий в GitHub Enterprise Server каждое действие возвращает результат, который указывает на успешное или неуспешное выполнение. Результат может быть представлен с использованием кода состояния HTTP и тела ответа.

Коды состояния HTTP – это числовые значения, которые возвращаются сервером в ответ на запрос клиента и указывают на результат выполнения действия.

При определении результатов выполнения действий в GitHub Enterprise Server следует обратить внимание на следующие коды состояния HTTP:

200 OK: Запрос успешно выполнен и вернул запрошенные данные.

201 Created: Запрос успешно создал новый ресурс.

204 No Content: Запрос выполнен успешно, но в ответе нет данных для передачи.

400 Bad Request: Запрос не может быть выполнен из-за неверного синтаксиса либо другой ошибки со стороны клиента.

401 Unauthorized: Для доступа к запрашиваемому ресурсу требуется аутентификация, но она не была предоставлена.

403 Forbidden: У пользователя нет прав доступа к запрашиваемому ресурсу.

404 Not Found: Запрашиваемый ресурс не найден на сервере.

500 Internal Server Error: Возникла внутренняя ошибка сервера при обработке запроса.

Вместе с кодом состояния HTTP можно использовать тело ответа для предоставления дополнительной информации о результате выполнения действия.

При разработке собственных действий в GitHub Enterprise Server рекомендуется использовать соответствующие коды состояния HTTP и предоставлять информативное тело ответа, чтобы упростить понимание результатов выполнения действий. Результаты выполнения действий могут быть важны для пользователя или автоматических систем, которые используют эти действия.

Упрощение процесса отладки

• Логирование: При отладке кода необходимо иметь возможность просматривать логи выполнения. GitHub Enterprise Server предоставляет ряд инструментов для регистрации сообщений об ошибках, предупреждениях и других событиях.
• Отладочные точки: Для анализа состояния кода в определенных местах программы можно использовать отладочные точки. В этих точках выполнение программы будет приостановлено, и вы сможете просмотреть значения переменных и другую информацию.
• Инструменты трассировки стека: При возникновении ошибки в коде часто необходимо смотреть, как программа дошла до этого момента. GitHub Enterprise Server предоставляет инструменты для трассировки стека, которые помогут понять последовательность вызовов функций и методов.
• Профилирование производительности: Если ваш код работает медленно или потребляет слишком много ресурсов, можно использовать инструменты для профилирования производительности. Они позволяют идентифицировать узкие места в коде и оптимизировать его.

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