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

Мандат

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

Это Мандат — место, где вы указываете, что может делать CoRoid без участия человека. Оно имеет отдельную позицию в навигации рядом с разделом «Quality Control», и состоит из двух частей: Обзор показывает, что настроено, а Настройки — место, где можно это изменить.

Что показывает раздел «Обзор»

Раздел «Обзор» отвечает на один вопрос: что делает CoRoid без вашего участия?

Все начинается с одного предложения, например: «CoRoid самостоятельно запускает исправления уязвимостей и учится выполнять слияние в фоновом режиме. Все остальные шаги ждут вашего вмешательства». Если CoRoid также самостоятельно исправляет или блокирует запросы на слияние, во второй строке об этом будет сказано. Под ней указаны четыре шага, определённые Мандатом, в порядке их выполнения:

ШагЧто это означает
Начать работуCoRoid запускает задачу, о которой никто не просил, в рамках одной из ваших целей
СлияниеCoRoid выполняет слияние pull request
РазвертываниеCoRoid разворачивает изменения в окружении
ОткатитьCoRoid отменяет неудачное развертывание

Каждый шаг указывает одно из следующего:

  • Запрашивает у вас разрешение. Для этого нет разрешения, поэтому действие выполняет человек.
  • Учится в фоновом режиме. Разрешение есть, но система лишь фиксирует, что бы она сделала. В шаге указывается, с какого момента и что было бы сделано до сих пор.
  • Выполняет самостоятельно. Активное разрешение покрывает этот шаг, и в нём указывается, для какой работы и как о вас сообщается.
  • Остановлено CoRoid. CoRoid сама остановила выполнение шага по разрешению. Откройте его, чтобы увидеть причину.
  • Только исправления уязвимостей (Начать работу). CoRoid запускает исправления уязвимостей в соответствии с настройками раздела «Безопасность», а всё остальное инициирует человек.

Для шага можно открыть его разрешение в разделе «Настройки» или создать новое разрешение для него.

Ниже перечислены шаги:

  • Всегда решение за человеком: защищённые пути и количество открытых запросов на слияние CoRoid в проекте. Изменения в защищённых путях никогда не сливаются или разворачиваются CoRoid, независимо от наличия разрешения.
  • Цели: на что направлена работа CoRoid, сколько средств на неё выделяется и что происходит с этой работой.
  • Проекты: Если проект приостановлен или имеет ограниченное разрешение, для него выделяется отдельная строка. Остальные проекты следуют общим правилам организации.

Владельцы и администраторы могут приостановить автономную работу прямо в разделе «Обзор».

Настроить

  1. Откройте Мандат → Настройки и выберите Начать с готового шаблона, или Новое разрешение для одного шага.
  2. Разрешение сначала работает в фоновом режиме. Дайте ему поработать некоторое время над вашими реальными задачами.
  3. Откройте разрешение и прочитайте, что бы оно сделало. Если результат вас устроит, выберите Сделать активным.
  4. Если вы хотите получать уведомления в Slack или Telegram, добавьте маршрут для Что делает CoRoid в разделе Настройки → Подключения → Маршруты уведомлений.

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

Настройки

В разделе «Настройки» сначала указана информация об организации, затем — о каждом проекте. В каждой строке показано, что настроено; при выборе строки открывается редактор в боковой панели. Ничего не редактируется непосредственно на странице.

ГруппаСтроки
АвтономностьПриостановить, со всеми удержаниями и приостановками; раздел Резерв восстановления
РазрешенияПо одной строке на разрешение, с Начать с готового шаблона и Новое разрешение
ЦелиПо одной строке на цель, с Новая цель
ОграниченияЗащищённые пути, Действия по доставке, Открытые запросы на слияние, Агенты
ИсторияЛюбые изменения Мандата и все решения, принятые на его основе

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

Разрешения

Разрешение разрешение — это одно из действий, которое CoRoid может выполнять без участия человека. В строке указано название действия, например «Слияние работы, запрошенной человеком», и описан его охват:

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

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

Разрешение на развертывание также может ограничивать изменения в одном релизе: сколько объединённых pull request может содержать релиз, чтобы CoRoid мог его развернуть. Более крупный релиз остаётся на развертывание человеком, поэтому пакет изменений, который может пройти только целиком, не попадёт в production без его участия.

Грант покрывает один из четырёх этапов или одно из двух действий, которые выполняет CoRoid с pull-запросами:

  • Исправлять pull-запросы. Если проверки завершаются ошибкой для pull request собственной работы CoRoid, CoRoid запускает цикл их исправления. Без гранта на такую работу он оставляет ошибку на рассмотрение рецензента. Если вы сами выберете опцию «Исправить неудачные проверки», грант не потребуется.
  • Блокировать pull-запросы. Если при Рецензировании CoRoid обнаруживает проблему, требующую исправления, он запрашивает внесение изменений, и pull request ждёт вмешательства человека. Без гранта на проект рецензия остаётся лишь комментарием, а соответствующая проверка не завершается ошибкой. Грант на блокировку покрывает все pull request в рамках своего проекта, независимо от того, кто их открыл и насколько они рискованные, за исключением случаев, когда затрагиваются пути, исключённые из действия гранта.

Оба эти действия CoRoid выполнял и до появления грантов. В каждой организации они уже активны как гранты, поэтому ничего не изменилось после того, как они стали отдельными настройками: ограничьте их действие определёнными проектами или отмените — и CoRoid прекратит их выполнение. Приостановка также останавливает их.

Панель настроек гранта отображает только то, что требуется для соответствующего этапа. Решения о начале работы, исправлении и откате изменений принимаются до внесения любых изменений в классификацию, поэтому у них нет уровня риска или исключённых путей. Грант на блокировку не имеет параметра «чья работа»: он покрывает всю деятельность pull request.

CoRoid больше не запрашивает разрешения на выполнение работы: решение о начале работы принимается в тот же момент. Грант на выполнение работы подтверждает это, и его можно отменить.

Грант начинает свою работу в режиме теневого режима

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

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

Что он мог бы сделать

Откройте грант, чтобы увидеть:

  • как часто CoRoid запрашивал его использование и что он мог бы разрешить в теневом режиме;
  • для гранта на слияние за последние 30 дней: сколько pull-запросов такого типа было слито, сколько грант мог бы слить, почему остальные не были слиты, и каждый из тех, что грант мог бы слить, но позже был отменён, исправлен или дополнен;
  • что необходимо гранту, чтобы стать активным.

Грант на изменения с уровнем оценки Низкий не требует ничего дополнительного: правила уже определяют этот уровень. Грант на изменения с уровнем оценки Средний зависит от модели, поэтому становится активным только при наличии определённых данных: как минимум 30 проверенных pull-запросов этого типа без ложных одобрений и как минимум 10 зафиксированных ошибочных изменений, каждое из которых было заблокировано. До этого момента грант указывает, чего ему ещё не хватает.

Начать с предустановки

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

ПредустановкаЧто она добавляет
ИсправлениеНачать работу в рамках ваших целей
СлияниеИсправить и слить такую работу, если её уровень оценки — Низкий
РазвернутьСлить и развернуть в указанной вами среде
Замкнутый циклРазвернуть и откатить такую среду при сбое развёртывания
Держать зависимости в актуальном состоянииСливать обновления зависимостей с уровнем оценки Низкий

Предустановка не активирует ни один мандат и не добавляет ничего из того, что у вас уже есть.

Проект может ограничить действие гранта

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

Когда сам CoRoid приостанавливает грант

  • Временно приостановлен. Рецензент CoRoid или его система оценки рисков изменились, и грант ещё не был протестирован в новой версии. Он автоматически станет активным, как только это произойдёт.
  • Приостановлен из-за срабатывания ограничителя. Pull-запросы, разрешённые к слиянию грантом, позже отменялись, исправлялись или дополнялись чаще, чем pull-запросы, созданные людьми в тех же проектах. Одна ошибка не приводит к такому результату. Грант отображает оба показателя. Человек может снять приостановку и указать причину.

Что может слить грант

Грант на слияние указывает, чью работу он покрывает. Он по-прежнему покрывает только изменения с уровнем оценки, не выше установленного им уровня.

РаботаЧто он покрывает
Работа, запрошенная у людейpull request, открытый CoRoid для выполнения задачи, запрошенной человеком
Работа в рамках целиpull request, открытый CoRoid для работы, начатой в рамках одной из ваших целей
Обновления зависимостейpull request от Dependabot или Renovate (в GitLab — merge-запрос, открытый ботом с токеном доступа проекта или группы из renovate/ ветку), которая обновляет пакеты npm — каждый до патч- или минорной версии в той же линейке версий, опубликованной не менее 7 дней назад, без новых установочных скриптов и с файлом блокировки, соответствующим package.json, и отсутствует открытое уведомление о проблемах безопасности. Такое обновление получает статус «Низкий» после истечения 7 дней.
Доверенные пользователиpull request — это изменение от участника, указанного в мандате, при котором все коммиты, сделанные после базовой версии, были созданы и зафиксированы с использованием связанного аккаунта GitHub этого участника, а подпись каждого коммита подтверждена GitHub. При открытии запроса на слияние в GitLab от связанного аккаунта участника, GitLab проверяет подпись каждого коммита, а адрес электронной почты автора и коммиттера совпадает с данными, подтверждёнными участником в GitLab. Коммит, сделанный в веб-редакторе или отправленный другим пользователем, требует вмешательства человека.

Как сливается мандат

План слияния в Factory размещает pull request, охватываемый мандатом, под CoRoid может слить сейчас, и поезд слияния выполняет его. В момент слияния CoRoid снова запрашивает мандат, поэтому пауза, приостановка, превышение лимита или новый коммит после формирования плана могут остановить процесс.

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

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

Уведомить и остановить

Мандат определяет способ уведомления о слиянии:

  • Сначала — и ожидание команды «Остановить». Когда поезд слияния берёт запрос на слияние, ответственное лицо мандата и тот, кто инициировал работу, получают уведомление. CoRoid выполняет слияние по окончании окна времени, например через 10 минут, если кто-то не нажмёт Остановить в уведомлении или в плане слияния, либо, при наличии связанного аккаунта, в сообщении в Slack или Telegram. Остановленный pull request ждёт решения человека.
  • После каждого. Вам сообщают о завершении слияния.

Связывание ваших аккаунтов

Мандат для доверенных пользователей и Согласования CoRoid должны знать, какой аккаунт GitHub или GitLab принадлежит вам. Функция остановки в Slack или Telegram нуждается в информации о вашем аккаунте в этих сервисах. В Профиль → Связанные аккаунты, связывайте их; платформа подтвердит корректность. CoRoid сохраняет ID и имя аккаунта, но не токен. Для GitLab также сохраняется хэш каждого подтверждённого вами адреса электронной почты (не сами адреса), что позволяет определить, чей это коммит; повторно свяжите аккаунт после добавления нового адреса. Отвязать удаляет всю информацию. Если в вашей организации используется самостоятельно управляемый GitLab, он появится в списке после настройки владельцем или администратором (Связывание аккаунтов пользователей в вашем GitLab).

Цели

Это цель определяет направление деятельности CoRoid самостоятельно, проекты, в которых она реализуется, и допустимый объём расходов. В более ранних версиях цели назывались мандатами; Цели подробно описаны здесь.

Цель задаёт CoRoid задачу и бюджет. Запросы из ваших систем, которые обрабатываются в рамках цели, начинаются согласно описанию в Когда начинается работа. CoRoid самостоятельно обрабатывает файлы в рамках цели, например, для последующих действий при неудачном результате изменений; для этого требуется активный мандат на Начать работу; до этого момента процесс ожидает инициации человеком. Исключением являются исправления в области безопасности: они запускаются в соответствии с настройками Безопасности.

Лимиты

То, что CoRoid никогда не может делать самостоятельно, независимо от условий мандата:

  • Защищённые пути. Каждое изменение в них решает человек. CoRoid защищает процесс входа и доступ, расчёты и платежи, секреты и учётные данные, криптографию, миграции баз данных, файлы блокировки, конвейеры CI, контейнеры и инфраструктуру; вы также можете добавить собственные пути. Удалить элементы из списка CoRoid может только владелец, при этом причина фиксируется.
  • Действия по доставке. Максимальный объём действий, разрешённых мандатом: слияние, деплой и откат — каждое из них может быть разрешено, запрошено или запрещено.
  • Открытые запросы на слияние. Количество открытых запросов на слияние CoRoid в проекте. При достижении лимита работа, запущенная автоматически, приостанавливается; запросы от человека всегда обрабатываются.
  • Агенты. Насколько далеко может заходить агент и могут ли автоматизации и расписания создавать задачи. Возможность блокировки CoRoid Рецензированием для pull request — это параметр гранта.

История

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

Когда CoRoid запрашивает у вас решение

Некоторые действия требуют предварительного ответа человека. Каждое такое действие отображается в строке под Требует вашего участия в Factory: что, где и почему просит выполнить CoRoid. Одобрить один раз позволяет выполнить действие один раз. Отклонить предотвращает выполнение действия. Подробнее в Factory.

Кто может изменить его

Владельцы и администраторы могут изменять Мандат. Участники имеют право на чтение всего содержимого. Агенты и учетные записи службы CoRoid полностью лишены возможности его изменять.

Любое решение, принятое в рамках соответствующего разрешения, также фиксируется в потоке аудита вашей организации от имени CoRoid, при этом указываются само разрешение и его версия.