Ubic release-it config

Стандартная конфигурация для release-it.

Требования

• release-it 18 https://github.com/release-it/release-it
• @release-it/conventional-changelog 10 и новее.* https://github.com/release-it/conventional-changelog
• Удалить пакет conventional-changelog-conventionalcommits из проекта. Подробнее в FAQ

Важно!

Версия release-it 19+ требует версию nodejs 22, необходимо устанавливать именно 18 версию.

Установка

Установить в проект конфиг и пакеты утилиты:

yarn add -D [email protected] @release-it/conventional-changelog @ubic/release-it-config

Настройка

Создать файл конфигурации .release-it.ts в корне проекта:

import { releaseItConfig } from '@ubic/release-it-config';
import { type Config } from 'release-it';

export default releaseItConfig satisfies Config;

Добавить в package.json скрипт для релиза

npm pkg set scripts.release="release-it"

Указание пути до файла конфига

При желании, можно изменить расположение файла конфига и указать его в скрипте:

// package.json
"scripts": {
  // ...
  "release": "release-it --config ./config/.release-it.ts"
}

Вывод пути до docker-образа тега

Можно настроить автоматический вывод пути до будущего докер-образа при сборке. Для этого нужно запускать release-it в verbose режиме:

// package.json
"scripts": {
  // ...
  "release": "release-it --verbose"
}

Сборка pre-релизов

Для сборки pre-релиза используется флаг --preRelease. Будущая версия выведется автоматически.

#  1.2.2 -> 1.2.3-rc.0
yarn release --preRelease=rc

#  1.2.3-rc.0 -> 1.2.3-rc.1
yarn release --preRelease

#  1.2.3-rc.1 -> 1.2.3-beta.0
yarn release --preRelease=beta

Подробное описание процесса сбора pre-релизов описано в документации release-it.

FAQ

• Формат changelog не разделяется по секциям (добавлено, изменено и т.д.) и выглядит как-то так:

2.6.9 (2025-06-10)

• Фильтрация списка пользователей [787ce72]

Проблема: в проекте установлена dev-зависимость conventional-changelog-conventionalcommits и ее версия ниже 8.0.0.

Решение: удалить пакет conventional-changelog-conventionalcommits из проекта.