Как выпускать Jdbi

Предварительные требования

• Вы выполнили шаги на https://central.sonatype.org/pages/ossrh-guide.html, чтобы настроить ваш аккаунт Sonatype. Этот аккаунт необходим для публикации выпусков на oss.sonatype.org и оттуда в Maven Central.
• Вы создали и загрузили ключ GNUPG на сервер ключей по адресу http://pool.sks-keyservers.net/. Maven Central требует, чтобы все выпуски были подписываться с помощью ключа GNUPG.
• Вы создали личный доступный токен (Personal Access Token, PAT) на github со правами repo. Этот токен необходим для развертывания сайта документации. С использованием тонко настроенных личных токенов этот токен может быть ограничен доступом только к конкретному репозиторию, в данном случае используйте jdbi/jdbi.github.io как репозиторий.

Настройка Maven settings.xml

Создайте следующие записи в файле ~/.m2/settings.xml (или в специфическом месте для файла настроек Maven на вашей системе):

<servers>
  <server>
    <id>sonatype-nexus-staging</id>
    <username>... Ваше имя пользователя Sonatype OSS ...</username>
    <password>... Введите пароль Sonatype OSS ...</password>
  </server>
  <server>
    <id>github</id>
    <username>git</username>
    <password>... Ваш токен PAT github ...</password>
  </server>
</servers>

Эти две записи необходимы для создания выпусков проекта Jdbi. Если вы хотите иметь возможность также отправлять превью-выпуски на Sonatype, пожалуйста добавьте

<servers>
  <server>
    <id>sonatype-nexus-snapshots</id>
    <username>... Ваше имя пользователя Sonatype OSS ...</username>
    <password>... Введите пароль Sonatype OSS ...</password>
  </server>
</servers>

Перед началом

Это шаги выпуска, которые должны быть выполнены:

Обязательные:

• Обновите заметки о выпуске и страницу документации
• Локально скомпилируйте выпуск
• Опубликуйте выпуск на Maven Central
• Отправьте изменения кода и тэг на github
• Опубликуйте документацию
• Добавьте объявление о выпуске на github

Необязательные:

• Создайте ветку выпуска
• Выпустите дополнительные модули

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

Обновление заметок о выпуске и страницы документации

Убедитесь дважды, что файл с заметками о выпуске (RELEASE_NOTES.md в корневой директории) содержит все самые важные изменения для данного выпуска.

Откройте основной файл документации (docs/src/adoc/index.adoc), найдите строку == Release documentation и добавьте новую ссылку на постоянную документацию выпуска для нового выпуска:

* https://jdbi.org/releases/<version>[Выпуск <version> - <date>^]

где <version> — это версия выпуска, а <date> — текущая дата в формате ISO8601.

ПОЖАЛУЙСТА НЕ ПРОДУКЦИРУЙТЕ ВЫПУСК ДО УЧЕТОВ В ФАЙЛЕ RELEASE_NOTES.md И ФАЙЛЕ index.adoc!

Локальная компиляция выпуска

Создайте артефакты выпуска в Maven и разместите их в репозитории Sonatype staging. Используйте последнюю LTS версию Java (в настоящее время 21) для сборки артефактов.

$ make release

Измените версию выпуска, если необходимо, или просто нажмите Enter, если предлагаемая версия подходит.

Принять предложенные версии выпуска и превью-выпуска от Maven.

Забронируйте кофе. Процесс сборки выпуска занимает около шести минут на современном ноутбуке.

Если выпуск прошел успешно, будут созданы два новых коммита в ветке:

• коммит выпуска с версией выпуска
• коммит превью-выпуска с следующей версией превью-выпуска

Он также создает тэг выпуска, который указывает на коммит выпуска.

Выпуск без использования Docker

Первоначально, пожалуйста, не делайте этого. Но если вам действительно нужно, возможно запустить

$ MAVEN_ARGS=-Dno-docker=true make release

что пропустит все тесты связанные с Docker. Это явно не поддерживается и является временным решением в очень специфических ситуациях и может сломаться в любое время.

Опубликование выпуска на Maven Central

ЭТО НЕ ПОСЛЕДНИЙ ШАГ ВЫПУСКА! После того, как код будет отправлен, пожалуйста завершите процесс, отправив изменения кода и опубликуйте сайт документации!

• Откройте oss.sonatype.org и войдите
• Нажмите "Staging Repositories"
• Поиск за jdbi (в верхнем правом углу)
• Выберите репозиторий и нажмите "Close"
  • Закрытие репозитория означает его закрытие для дальнейших изменений
  • Nexus проверяет, что все загруженные файлы в репозитории staging соответствуют требованиям публикации в Maven Central
• Нажмите "Refresh", пока состояние репозитория не изменится на "closed"
  • Если это не работает, узнайте, какие правила не были удовлетворены, и начните заново! Ура!
• Нажмите "Release", чтобы отправить выпуск в Maven Central.
  • Введите описание, например "Jdbi release v"
• Нажмите "Refresh", пока состояние репозитория снова не изменится, что сделает его невидимым в поиске.

Отправка изменений кода на GitHub

Отправьте коммиты выпуска и тэг на GitHub:

$ git push --follow-tags

(или установите настройку push.followTags для git).

Опубликование документации

Перейдите в каталог выпуска и сгенерируйте документацию для сайта jdbi.org:

$ cd target/checkout
$ make release-docs

Добавление объявления о выпуске на GitHub

• Откройте https://github.com/jdbi/jdbi, нажмите на "Releases"
• "Начертить новый выпуск"
• Выберите только что отправленный тэг, используйте название выпуска JDBI
• Вставьте строки из заметок о выпуске в поле "Describe this release"
• Пожалуйста, убедитесь, что флажки "Set as the latest release" и "Create a discussion for the release" выбраны
• Нажмите "Publish release"

Выпуск дополнительных модулей

Малое количество модулей JDBI3 поддерживаются вне основного сборочного процесса. Рассмотрите возможность выпуска этих модулей:

• Модуль JDBI3 Guava Cache