Skip to content

Commit 413e4e2

Browse files
Totktonadasergos
authored andcommitted
tools: update release notes template
The given template comes from the time, when we had 1.10 and 2.x with the old release policy (see [1]). In fact, almost every aspect of this template is obsolete now. For example, we have no stable and non-stable releases anymore: there are pre-releases (marked with alpha, beta, rc keywords) and releases. We don't need to say explicitly that the given release is stable. Also, 1.10 is not LTS anymore (it is EOL) and 2.11 is not the latest series. The links needs an update too. So, I decided to write these templates from scratch, but keep the idea: give some release status information, highlight notable changes (for feature releases), provide a few hints about the update procedure. [1]: https://github.com/orgs/tarantool/discussions/6182 NO_DOC=dev tools NO_CHANGELOG=same NO_TEST=same
1 parent f40d1f3 commit 413e4e2

File tree

1 file changed

+25
-53
lines changed

1 file changed

+25
-53
lines changed

tools/gen-release-notes

Lines changed: 25 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -51,84 +51,56 @@ BUGFIXES_ANCHOR = '{{BUGFIXES}}'
5151
OVERVIEW_TEMPLATE = """
5252
## Overview
5353
54-
// {{{ BETA X.Y.1
54+
// {{{ 3.x
5555
56-
**TBD** is the [beta][release_policy] version of the **TBD** release series.
56+
Tarantool 3.x is the recommended release series. Users of Tarantool 2.11 are
57+
encouraged to update to the latest 3.x release.
5758
58-
This release introduces {{FEATURES}} new features and resolves {{BUGFIXES}} bugs since
59-
the **TBD** version. There can be bugs in less common areas. If you find any,
60-
feel free to [report an issue][issues] on GitHub.
59+
This release introduces {{FEATURES}} improvements and resolves {{BUGFIXES}}
60+
bugs since **TBD**.
6161
6262
Notable changes are:
6363
6464
* **TBD**
6565
* **TBD**
6666
* **TBD**
6767
68-
[release_policy]: https://www.tarantool.io/en/doc/latest/dev_guide/release_management/#release-policy
69-
[issues]: https://github.com/tarantool/tarantool/issues
68+
// }}} 3.x
7069
71-
// }}} BETA X.Y.1
70+
// {{{ 2.11
7271
73-
// {{{ STABLE X.Y.{2,3}
72+
2.x is the old stable release series. Users are encouraged to update to the
73+
latest 3.x release.
7474
75-
**TBD** is the **TBD**th [stable][release_policy] version of the **TBD** release
76-
series. It introduces {{FEATURES}} improvements and resolves {{BUGFIXES}} bugs since
77-
**TBD**.
75+
This is a bugfix release. It resolves {{BUGFIXES}} issues since the previous
76+
version.
7877
79-
The "stable" label means that we have all planned features implemented and we
80-
see no high-impact issues. However, if you encounter an issue, feel free to
81-
[report it][issues] on GitHub.
78+
// }}} 2.11
8279
83-
[release_policy]: https://www.tarantool.io/en/doc/latest/dev_guide/release_management/#release-policy
84-
[issues]: https://github.com/tarantool/tarantool/issues
85-
86-
// }}} STABLE X.Y.{2,3}
87-
88-
// {{{ LTS 1.10.Z
89-
90-
**TBD** is the next stable release in the [long-term support (LTS)
91-
version][release_policy][release_policy] 1.10.x release series.
92-
93-
The label "stable" means there are 1.10.x-based applications running in
94-
production for quite a while without known crashes, incorrect results or
95-
other showstopper bugs.
96-
97-
This release introduces {{FEATURES}} improvements and resolves roughly {{BUGFIXES}}
98-
issues since the **TBD** version.
99-
100-
[release_policy]: https://www.tarantool.io/en/doc/1.10/dev_guide/release_management/#release-policy
101-
[issues]: https://github.com/tarantool/tarantool/issues
102-
103-
// }}} LTS 1.10.Z
80+
Please, consider the full list of user-visible changes below.
10481
""".strip() # noqa: E501 line too long
10582

10683
COMPATIBILITY_TEMPLATE = """
10784
## Compatibility
10885
109-
// {{{ BETA / STABLE 2.Y.Z
110-
111-
Tarantool 2.x is backward compatible with Tarantool 1.10.x in the binary data
112-
layout, client-server protocol, and replication protocol.
113-
114-
Please [upgrade][upgrade] using the `box.schema.upgrade()` procedure to unlock
115-
all the new features of the 2.x series.
86+
Tarantool 2.x and 3.x are compatible in the binary data layout, client-server
87+
protocol, and replication protocol. It means that the updating may be performed
88+
with zero downtime for read requests and the-order-of-network-lag downtime for
89+
write requests.
11690
117-
[upgrade]: https://www.tarantool.io/en/doc/latest/book/admin/upgrades/
118-
119-
// }}} BETA / STABLE 2.Y.Z
91+
Please, follow the [upgrade procedure][upgrade] to plan your update actions.
12092
121-
// {{{ LTS 1.10.Z
93+
// {{{ 3.x
12294
123-
Tarantool 1.10.x is backward compatible with Tarantool 1.9.x in binary data
124-
layout, client-server protocol and replication protocol.
95+
Users of Tarantool 2.x may be interested in the [compat][compat] options that
96+
allow to imitate some 2.x behavior. This allows to perform application code
97+
update step-by-step, not all-at-once.
12598
126-
Please [upgrade][upgrade] using the `box.schema.upgrade()` procedure to unlock
127-
all the new features of the 1.10.x series.
99+
[compat]: https://www.tarantool.io/en/doc/latest/reference/configuration/configuration_reference/#compat
128100
129-
[upgrade]: https://www.tarantool.io/en/doc/1.10/book/admin/upgrades/
101+
// }}} 3.x
130102
131-
// }}} LTS 1.10.Z
103+
[upgrade]: https://www.tarantool.io/en/doc/latest/book/admin/upgrades/
132104
""".strip() # noqa: E501 line too long
133105

134106
ENTERPRISE_TEMPLATE = """

0 commit comments

Comments
 (0)