Лучшая практика использования дат в качестве версий в Maven - PullRequest
1 голос
/ 05 мая 2020

Мы создаем банку, которая извлекает описания для ЭБУ и коды неисправностей.

DescriptionFinder finder = new DescriptionFinder();
String response = finder.findEcmDesc("43"); 

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

Это автономный файл jar, и мы хотим обновлять его 3 раза в год и считаем, что дата выпуска версии - хорошая идея.

 <artifactId>pfm-common-descriptions</artifactId>
 <version>2020.5.1</version>
 <name>pfm-common-descriptions</name>

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

Вот некоторые из моих идей:

  • 2020.5.1
  • 2020.5.1_1 ( дата и версия на всякий случай)
  • 2020APR01

Я предполагаю, что наши клиенты могли бы использовать ключевое слово RELEASE:

<dependency>
  <groupId>blah.blah.blah</groupId>
  <artifactId>pfm-common-descriptions</artifactId>
  <version>RELEASE</version> **(this has actually been deprecated!)**
</dependency>

Но они не могут. И свидание все равно будет отличным показателем возраста. Мы настраиваем уведомления о том, когда JFrog (наш репозиторий maven) получит изменения.

Мысли? Стоит ли добавлять версию на дату? Какой формат вы используете?

1 Ответ

0 голосов
/ 05 мая 2020

Как правило, рекомендуется использовать semver для версий. Но некоторые этого не делают.

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

Наличие даты в версии на самом деле не добавляет смысла, с моей точки зрения.

Добавить уведомление при выходе новой версии? Это можно сделать с помощью semver.

Сообщите им, сколько лет их текущей версии? В каждой банке есть эта метаинформация, и пользователь может открыть ваш CHANGELOG.md и посмотреть, что было добавлено с момента выпуска их текущей версии.

Так что я не вижу причин, по которым semver здесь не подходит.

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