Как выпустить новую версию

Данное руководство в значительной степени основано на инструкциях по выпуску Prometheus (https://github.com/prometheus/prometheus/wiki/HOWTO-cut-a-new-release).

Управление ветками и стратегия управления версиями

Мы используем семантическое управление версиями (Semantic Versioning) (http://semver.org/).

Для каждого второстепенного выпуска мы ведём отдельную ветку с именем release-., например, release-1.1, release-2.0.

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

Если исправление ошибки случайно было объединено с основной веткой, необходимо создать cherry-pick коммитов в последней ветке выпуска, которые затем должны быть объединены обратно с основной веткой. Старайтесь избегать этой ситуации.

Поддержание веток выпуска для старых второстепенных выпусков происходит по мере возможности.

Подготовка к выпуску

Для выпуска патча работайте в ветке второстепенного выпуска, который вы хотите исправить.

Для нового основного или второстепенного выпуска создайте соответствующую ветку выпуска на основе основной ветки.

Измените версию в файле VERSION в корне репозитория. После этого необходимо перегенерировать ряд файлов, это автоматизировано с помощью следующей цели make:

$ make generate

Теперь, когда вся информация о версии была обновлена, запись о новой версии можно добавить в файл CHANGELOG.md.

Записи в CHANGELOG.md должны быть в следующем порядке:

• [CHANGE]
• [FEATURE]
• [ENHANCEMENT]
• [BUGFIX]

Создайте PR для проверки изменений версии и журнала изменений.

Подготовьте новый выпуск

После того как PR для нового выпуска будет объединён, убедитесь, что есть ветка выпуска для соответствующего выпуска. Для новых второстепенных выпусков создайте ветку release-.. Для выпусков патчей объедините основную ветку с существующей веткой выпуска. Если выпуск является выпуском патча для старого второстепенного выпуска, выберите соответствующие изменения.

Отправьте новую или обновлённую ветку выпуска в вышестоящий репозиторий.

Пометьте новый выпуск тегом с именем v.., например, v2.1.3. Обратите внимание на префикс v.

Вы можете выполнить тегирование в командной строке:

$ tag=$(< VERSION) && git tag -s "v${tag}" -m "v${tag}"
$ git push --tags

Подпись тега с помощью ключа GPG приветствуется, но если вы не можете добавить ключ GPG в свою учётную запись Github с помощью следующей процедуры (https://help.github.com/articles/generating-a-gpg-key/), вы можете заменить флаг -s флагом -a команды git tag, чтобы только аннотировать тег без подписи.

Наш CI-конвейер автоматически отправит новый образ Docker на quay.io.

Перейдите на страницу https://github.com/coreos/prometheus-operator/releases/new, свяжите новый выпуск с ранее отправленным тегом, вставьте изменения, внесённые в CHANGELOG.md, и нажмите «Опубликовать выпуск».

Сделайте вдох. Вы закончили выпуск.