doc: new SDK changelog format#5680
Conversation
maryiaLichko
force-pushed
the
doc-new-changelog-format
branch
from
b383e4d to
68bb1e4
Compare
github-actions
Bot
temporarily deployed
to
branch-doc-new-changelog-format
github-actions
Bot
temporarily deployed
to
branch-doc-new-changelog-format
maryiaLichko
force-pushed
the
doc-new-changelog-format
branch
from
0681448 to
f3da7bf
Compare
| В релизе обновлены ключевые зависимости платформы: Tarantool до 2.11.9, модуль metrics до 1.7.0, | ||
| а также утилита tt-ee до 2.12.0, в которой завершается активная разработка ветки v2.x. |
There was a problem hiding this comment.
Где завершается ветка 2х и почему это важно?
|
|
||
| В релизе обновлены ключевые зависимости платформы: Tarantool до 2.11.9, модуль metrics до 1.7.0, | ||
| а также утилита tt-ee до 2.12.0, в которой завершается активная разработка ветки v2.x. | ||
| Дополнительно обновлён модуль ``graphqlapi-helpers`` до 0.0.11-1. |
There was a problem hiding this comment.
Выглядит так же как и раньше, только больше букв.
|
|
||
| * Версия 2.x — старая стабильная ветка; рекомендуется обновляться до 3.x. | ||
| * Совместимость: Tarantool 2.x и 3.x совместимы с точки зрения формата бинарных данных, клиент-серверного протокола и протокола репликации. | ||
| Это означает, что обновление можно выполнить без простоя для операций чтения, а для операций записи простой будет порядка сетевой задержки (см. `upgrade procedure <https://www.tarantool.io/en/doc/latest/book/admin/upgrades/>`__). |
There was a problem hiding this comment.
По ссылке нет информации как обновиться с 2х до 3х без простоя.
| * Совместимость: Tarantool 2.x и 3.x совместимы с точки зрения формата бинарных данных, клиент-серверного протокола и протокола репликации. | ||
| Это означает, что обновление можно выполнить без простоя для операций чтения, а для операций записи простой будет порядка сетевой задержки (см. `upgrade procedure <https://www.tarantool.io/en/doc/latest/book/admin/upgrades/>`__). | ||
|
|
||
| Далее перечислены изменения, видимые пользователю: |
| * Добавлены флаги ``misc.memprof.available`` и ``misc.sysprof.available`` для | ||
| определения доступности соответствующего профайлера в текущей сборке. |
There was a problem hiding this comment.
Было бы неплохо ссылку на то как это использовать. Как использовать профайлер?
| Далее перечислены изменения, видимые пользователю: | ||
|
|
||
|
|
||
| Tools |
There was a problem hiding this comment.
Это касается tt-cli, tcm, ate или чего-то другого?
| graphqlapi-helpers | ||
| ~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| * Обновление модуля ``graphqlapi-helpers`` с 0.0.9-1 на 0.0.11-1. Новая версия работает без зависимостей от ``ddl-ee`` and ``crud-ee``. |
|
|
||
| LuaJIT | ||
| ^^^^^^ | ||
|
|
There was a problem hiding this comment.
Здесь можно было бы сделать подраздел Исправлено и перечислить правки, чтобы не писать Исправлено Исправлено ...
| - ``TARANTOOL_BASE_VERSION`` is the Community version which the Enterprise version is based on. | ||
| - ``REVISION`` is the SDK revision. Besides Tarantool itself, it includes the ``tt`` utility, a set of open and closed source modules, and examples. Learn more from :ref:`Package contents <enterprise-package-contents>`. | ||
|
|
||
| r708 |
There was a problem hiding this comment.
Предложил бы доструктурирововтать. В каждом модуле как в манифесте keepchanglog и как в TCF сделать разбивку:
Добавлено — для новых функций.
Изменено — для изменений в существующей функциональности.
Устарело — для функций, которые скоро будут удалены.
Удалено — для удалённых на данный момент функций.
Исправлено — для любых исправлений багов.
Безопасность — на случай уязвимостей.
| r708 | ||
| ---- | ||
|
|
||
| В релизе обновлены ключевые зависимости платформы: Tarantool до 2.11.9, модуль metrics до 1.7.0, |
There was a problem hiding this comment.
в SDK больше модулей, чем изменений. Если изменений не было, то лучше написать фразу "Описаны модулы, в которых были изменения. Если модуль отсутствует, то в нем не было обновлений"
|
|
||
| r708 | ||
| ---- | ||
|
|
There was a problem hiding this comment.
Еще момент. Мы же знаем, что в crud изменились права. И он есть в поставке, а тут его нет. Надо и остальные модули проверить и добавить описание
| * Исправлена запись разрешения индекса конструктора в JIT-компиляторе. | ||
| * Исправлено предупреждение UBSan в ``unpack()``. | ||
|
|
||
| Datetime |
There was a problem hiding this comment.
Надо добавить пояснение в каком компоненте исправление. Есть и модули, и типы данных
3 participants
Подробнее: https://jira.vk.team/browse/TNTP-7940
Дев: https://docs.d.tarantool.io/en/doc/doc-new-changelog-format/release/enterprise-changelog/