Выпуски Orbit

The Releases tab turns your git tags into a version history you can read: every tagged deployment, in order, with its commit, its author, its status and a link straight to the tag in your repository.

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

Где находится Releases

Откройте Orbit, выберите проект и выберите Releases в группе Deployments на ленте вкладок проекта. Страница озаглавлена Releases и описывает себя как развертывания на основе тегов: релиз создается, когда git тег совпадает с вашим шаблоном тега.

Соседняя вкладка Deployments перечисляет каждую сборку, помеченную или нет. Releases, это отфильтрованное представление: только те, которые вы отметили как версию.

Установка шаблона тега

Releases начинаются с шаблона. Откройте Settings, найдите карточку Git tag deploys и введите шаблон поиска, например v* или release-*. Если оставить это поле пустым, развертывания по тегам будут полностью отключены, именно поэтому заполнитель поля содержит текст v* (disabled).

Если шаблон установлен, отправка совпадающего тега развертывает в production и записывает результат как релиз. Без него вкладка Releases показывает пустое состояние с предложением отправить тег и установить шаблон в Settings.

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

Создание релиза

Весь рабочий процесс с вашей стороны состоит из двух команд git:

git tag -a v1.4.0 -m "Checkout flow rebuild"
git push origin v1.4.0

Orbit получает тег, проверяет его по вашему шаблону, развертывает помеченный коммит в production и записывает релиз. Он отображается на этой вкладке с бейджем Building и переходит в Deployed при успешном развертывании или Failed, если сборка завершилась ошибкой.

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

Пометка существующего развертывания

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

Тег в форме версии, это тег вроде 1.4, 1.4.0, v1.4.0 или v2.0.0-rc1. Все остальное остается простым тегом развертывания и не создает запись релиза.

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

Чтение релиза

Каждая строка релиза показывает:

Тег как название релиза.
Коммит и его сообщение.
Автора, отображаемого как by name.
Окружение, в которое он был развернут, с цветовой кодировкой по типу.
Бейдж статуса: Deployed, Building или Failed.
Ссылку View on на тег в вашем репозитории.
Ссылку на основное развертывание.

Ссылка View on указывает на правильное место для каждого провайдера: страницу releases на GitHub, страницу тега на GitLab или источник с этим тегом на Bitbucket.

Примечания к релизу

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

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

Один релиз на тег

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

Счетчик в верхней части дает общее количество, а список охватывает щедрое окно недавних помеченных развертываний, а не всю историю проекта.

Правильное использование Releases

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

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

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

Отправка тега развертывает непосредственно в production, если она совпадает с вашим шаблоном. Это не обходит ничего другого: блокировки развертывания, требования к одобрению и окна заморозки по-прежнему применяются как настроено. Но это означает, что тег, отправленный по ошибке,, это развертывание в production, а не черновик. Смотрите Развертывание проекта для доступных ограничений.

Откат релиза

Релизы, это развертывания, поэтому откат одного из них, это обычный процесс отката: откройте развертывание и восстановите предыдущее успешное. Смотрите Откат развертывания.

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

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

Тег был отправлен, но релиз не появился. Проверьте шаблон в Settings, затем проверьте, что тег действительно достиг удаленного. git push origin v1.4.0 отправляет один тег; git push один не отправляет никаких.

Релиз показывает Failed. Сборка завершилась ошибкой, как и для отправки ветки. Откройте развертывание и прочитайте журнал: Чтение журналов сборки.

Ссылка View on отсутствует. Проект не имеет подключенного репозитория, поэтому нет куда ссылаться. Подключите один: смотрите Подключение репозитория GitHub.

Вручную помеченное развертывание не указано в списке. Тег не имеет формы версии. Переименуйте его на что-то вроде v1.4.0.

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

Куда дальше

Развертывание проекта для полного цикла развертывания и его ограничений.
Откат развертывания когда релиз идет неправильно.
Аннотации временной шкалы Orbit для записи того, что изменил релиз.