Настройка кодов выхода для действий – GitHub Enterprise Cloud Docs

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

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

В этом руководстве вы узнаете, как использовать файл .github/workflows/main.yml для настройки кодов выхода для действий. Вы также узнаете о различных свойствах, которые вы можете использовать для определения кодов выхода для разных действий.

Создание нового кода выхода

Для настройки кодов выхода для действий в вашем репозитории в GitHub Enterprise Cloud вам понадобится создать новый код выхода. Этот код будет использоваться для определения состояния, в котором находится ваше действие после его завершения.

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

1. Откройте репозиторий, в котором вы хотите настроить коды выхода для действий.
2. В правом верхнем углу страницы нажмите на вкладку “Actions” (Действия).
3. В списке доступных действий найдите действие, для которого вы хотите создать новый код выхода, и нажмите на него.
4. На странице с описанием действия найдите раздел “Outputs” (Выходы) и нажмите на ссылку “Create new output” (Создать новый выход).
5. Введите имя нового кода выхода и его описание. Имя должно быть уникальным для каждого кода выхода в рамках действия.
6. Выберите тип данных, который будет возвращаться кодом выхода, например “строка” или “число”.
7. Нажмите на кнопку “Create” (Создать) для создания нового кода выхода.

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

Шаг 1: Откройте GitHub

Перейдите на официальный сайт GitHub по адресу https://github.com/.

Если у вас уже есть аккаунт, войдите в систему, используя свои учетные данные. Если учетной записи еще нет, зарегистрируйтесь, нажав кнопку “Sign up for GitHub”

Шаг 2: Выберите репозиторий

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

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

1. Откройте раздел “Actions” на странице выбранного репозитория.
2. Выберите “Set up a workflow yourself” или откройте существующий файл с действием.
3. При необходимости создайте новый файл с расширением “.yml” в папке “.github/workflows”.
4. Внесите необходимые изменения в файл с действием или создайте новый файл с нужным содержимым.
5. Сохраните изменения и завершите настройку выбранного репозитория.

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

Шаг 3: Нажмите на вкладку “Actions”

1. Откройте ваш репозиторий на GitHub.

2. В верхней части страницы найдите вкладку “Actions” и нажмите на нее.

На вкладке “Actions” вы увидите список всех ваших действий и их статусов. Вы также можете просмотреть информацию о каждом действии, включая коды выхода.

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

Примечание: Настройка кодов выхода доступна только для некоторых типов действий, таких как действия на основе Docker контейнеров или сценарии на языке JavaScript.

Теперь вы готовы перейти к шагу 4 и настроить коды выхода для вашего действия.

Редактирование кодов выхода

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

Чтобы отредактировать коды выхода вашего действия, следуйте этим шагам:

1. Перейдите на страницу вашего действия в репозитории.
2. Нажмите на вкладку “Actions” в верхней части страницы.
3. Выберите ваше действие в списке действий и нажмите на него.
4. В правом верхнем углу страницы нажмите на кнопку “Edit”.
5. Перейдите в раздел “Codes”.
6. В поле “Exit codes for success” укажите коды выхода, которые должны считаться успешными.
7. В поле “Exit codes for failure” укажите коды выхода, которые должны считаться ошибочными.
8. Нажмите на кнопку “Save” внизу страницы, чтобы сохранить изменения.

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

Шаг 1: Откройте GitHub

Если у вас нет учетной записи на GitHub, вы можете зарегистрироваться, нажав на кнопку “Sign Up” или “Регистрация” и заполнив необходимую информацию.

После успешного входа вы будете перенаправлены на вашу личную страницу GitHub. Здесь вы найдете все ваши репозитории, участников и другую полезную информацию.

Теперь вы готовы перейти к следующему шагу настройки кодов выхода для действий на GitHub Enterprise Cloud.

Шаг 2: Выберите репозиторий

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

1. Перейдите на страницу вашего профиля в GitHub Enterprise и выберите вкладку “Репозитории”.

2. Найдите репозиторий, для которого вы хотите настроить коды выхода для действий.

3. Щелкните на названии репозитория, чтобы открыть его.

Вы можете использовать поиск или просматривать свои репозитории вручную, чтобы найти нужный репозиторий.

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

Шаг 3: Нажмите на вкладку “Actions”

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

Чтобы перейти к настройке кодов выхода, нажмите на вкладку “Actions” в вашем репозитории на GitHub Enterprise Cloud.

На странице “Actions” вы найдете список всех ваших действий и их текущий статус. Чтобы настроить коды выхода для конкретного действия, выберите его из списка.

На странице настройки действия вы увидите раздел “Коды выхода”. Здесь вы можете определить различные коды выхода и сообщения, которые будут возвращаться при выполнении действия.

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

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