Документация

Настройки релиза

Настройте среды, через которые проходит релиз, правила для каждой из них, а также порядок запуска деплоев и получения отчетов о их выполнении.

Параметры релизов хранятся вместе с остальными настройками проекта. Откройте проект, выберите Настройки, затем раскройте Релизы. Здесь представлено три экрана, и каждый из них отвечает на один вопрос.

Среды
Куда направляется релиз? Добавьте остановки и расставьте их в порядке.
Правила утверждения
Что должно быть выполнено заранее? Утверждения, роли, чек-лист и правила экстренных исправлений для каждого окружения.
Конвейер деплоя
Кто выполняет деплой и как Coroid получает обратную связь? Ваш конвейер или Coroid инициируют процесс; токен отчётности позволяет CI/CD подтвердить результат.
Параметры проекта → Раздел «Релизы» содержит три экрана, каждый со своим вопросом.

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

Среды

Куда направляется релиз и в каком порядке?

Каждый проект изначально включает среду Production. Чтобы добавить другие целевые среды для деплоя, например Staging или QA, воспользуйтесь командой Добавить среду. Присвойте каждой среде название. Coroid предлагает ключ на основе этого названия, например staging. Ваш CI/CD использует этот ключ при формировании отчета о деплое, поэтому сохраняйте его неизменным после того, как конвейеры начнут его применять.

Задайте порядок с помощью Идет после. Если Staging расположен перед Production, а Production — после Staging, то путь развёртывания будет выглядеть как Staging › Production. На странице релиза этот порядок отображается как траектория развертывания, а правила согласования могут требовать успешного прохождения предыдущей среды.

Правила согласования

Что должно быть выполнено перед тем, как релиз будет развернут в данной среде?

Выберите нужную среду в верхней части экрана. Правила задаются для каждой среды отдельно, поэтому для Staging они могут быть менее строгими, а для Production — более жесткими.

  • Требуемое количество согласований: сколько разных лиц должны дать свое одобрение. Значение ноль позволяет релизу развернуться сразу после прохождения проверок.
  • Кто может согласовывать: роли в организации, которым разрешено осуществлять согласование.
  • Разделить инициатора и согласующих: человек, запустивший процесс деплоя, не может сам его согласовывать, а тот, кто редактирует примечания к релизу, не имеет права их утверждать.
  • Успешное прохождение проверок качества: параметр всегда включен. График качества проекта с release_validation триггер запускается для конкретного коммита. Опубликуйте этот график в настройках качества проекта.
  • Сначала предыдущая среда: релиз должен уже быть развернут в среде, которая предшествует текущей.
  • Утвержденные примечания к релизу: текущие примечания требуют утверждения, а любые последующие изменения нуждаются в новом утверждении.
  • Контрольный список: ручные шаги, которые подтверждает пользователь на странице релиза, например «Проверка миграции базы данных». Укажите, является ли элемент обязательным или необязательным. Для обязательного элемента можно установить временное исключение. Владелец или администратор указывает причину и срок действия исключения — до 24 часов; такое исключение применяется только к конкретному коммиту и среде.
  • Правила для экстренных исправлений: более простые правила для срочных исправлений: количество необходимых утверждений и применимость предыдущих настроек среды и утверждения примечаний. Проверки качества и элементы контрольного списка остаются обязательными; экстренные исправления могут утверждать только владельцы и администраторы.

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

Конвейер деплоя

Кто инициирует деплой и как Coroid определяет результат выполнения?

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

  • Мой конвейер запускается автоматически: сохраняйте текущий процесс. Coroid фиксирует факт деплоя, когда об этом сообщает ваш CI/CD, или когда владелец/администратор регистрирует внешний деплой на странице релиза.
  • Coroid запускает рабочий процесс GitHub Actions или Coroid запускает конвейер GitLab CI/CD: этот вариант отображается, если репозиторий проекта находится у соответствующего провайдера. Укажите ветку или тег, указывающий на коммит релиза, файл рабочего процесса для GitHub и точное имя задания, отвечающего за деплой. Coroid проверяет указанный реф перед запуском рабочего процесса и убеждается, что задание выполнено успешно, прежде чем принять результат.

В разделе Отчеты о деплое, создайте токен для отчетности по конкретной среде и сохраните его в виде секрета в вашем CI/CD. Coroid отобразит токен один раз и сохранит только его хэш-значение. Замена токена немедленно отменит действие старого токена. На том же экране указаны конечная точка, идентификатор проекта и ключ среды, необходимые для работы конвейера, а также информация о поступлении отчетов. События деплоя и настройка CI содержит формат событий и примеры.

Перенос настроек между организациями

Экспорт и импорт настроек включают среды, их порядок, конфигурацию конвейера и опубликованные правила, включая правила для экстренных исправлений. Токены отчетности при экспорте не сохраняются; после импорта необходимо создать новые токены.