Нужно ли обновлять версию semver при добавлении примеров в пакет? - PullRequest
0 голосов
/ 24 мая 2018

Я делаю пакет npm и опубликовал его как версию 1.0.0, потому что был доволен открытым API.Но сейчас я добавляю подпроект «examples», чтобы продемонстрировать, как использовать библиотеку.Очевидно, я не буду публиковать пример проекта как часть библиотеки (он будет добавлен в .npmignore), но он будет на моем репозитории github.Есть ли для этого правила семантической версионности?Стоит ли обновлять версию патча, минорную версию или вообще ничего?

С одной стороны, я думаю, что не стоит обновлять версию, поскольку она не будет опубликована в npm, поэтому обычные пользователи приложения победилидаже не заметил разницу в упаковке.С другой стороны, правила semver гласят, что вы должны обновлять «патч» или «минорную» версию при внесении изменений в документацию, даже если документация также не публикуется.

1 Ответ

0 голосов
/ 25 мая 2018

соответствующая спецификация здесь # 3 :

Как только версионный пакет выпущен, содержимое этой версии НЕ ДОЛЖНО быть изменено.Любые модификации ДОЛЖНЫ быть выпущены как новая версия.

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

...