Skip to content

tools: update release notes template #11210

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 18, 2025

Conversation

Totktonada
Copy link
Member

@Totktonada Totktonada commented Feb 26, 2025

The given template comes from the time, when we had 1.10 and 2.x with the old release policy (see https://github.com/orgs/tarantool/discussions/6182). 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.


Resulting templates are below.

3.x

# Overview

Tarantool 3.x is the recommended release series. Users of Tarantool 2.11 are
encouraged to update to the latest 3.x release.

This release introduces {{FEATURES}} improvements and resolves {{BUGFIXES}}
bugs since **TBD**.

Notable changes are:

* **TBD**
* **TBD**
* **TBD**

Please, consider the full list of user-visible changes below.

## Compatibility

Tarantool 2.x and 3.x are compatible in the binary data layout, client-server
protocol, and replication protocol. It means that the updating may be performed
with zero downtime for read requests and the-order-of-network-lag downtime for
write requests.

Please, follow the [upgrade procedure][upgrade] to plan your update actions.

Users of Tarantool 2.x may be interested in the [compat][compat] options that
allow to imitate some 2.x behavior. This allows to perform application code
update step-by-step, not all-at-once.

[compat]: https://www.tarantool.io/en/doc/latest/reference/configuration/configuration_reference/#compat

[upgrade]: https://www.tarantool.io/en/doc/latest/book/admin/upgrades/

2.11

# Overview

2.x is the old stable release series. Users are encouraged to update to the
latest 3.x release.

This is a bugfix release. It resolves {{BUGFIXES}} issues since the previous
version.

Please, consider the full list of user-visible changes below.

## Compatibility

Tarantool 2.x and 3.x are compatible in the binary data layout, client-server
protocol, and replication protocol. It means that the updating may be performed
with zero downtime for read requests and the-order-of-network-lag downtime for
write requests.

Please, follow the [upgrade procedure][upgrade] to plan your update actions.

[upgrade]: https://www.tarantool.io/en/doc/latest/book/admin/upgrades/

@coveralls
Copy link

coveralls commented Feb 26, 2025

Coverage Status

coverage: 87.455% (+0.02%) from 87.432%
when pulling 87735b6 on Totktonada:update-release-notes-template
into 6054c73
on tarantool:master
.

@Totktonada Totktonada added backport/2.11 Automatically create a 2.11 backport PR backport/3.2 Automatically create a 3.2 backport PR backport/3.3 Automatically create a 3.3 backport PR labels Feb 26, 2025
@Totktonada Totktonada requested a review from a team February 26, 2025 22:30
@locker locker removed their assignment Feb 28, 2025
Copy link
Collaborator

@sergepetrenko sergepetrenko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! It was a pain editing this template for each release.

@sergepetrenko sergepetrenko removed their assignment Mar 4, 2025
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
@Totktonada Totktonada force-pushed the update-release-notes-template branch from 4b4358a to 87735b6 Compare March 4, 2025 17:13
Copy link
Contributor

@sergos sergos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, LGTM!

@sergos sergos merged commit 413e4e2 into tarantool:master Mar 18, 2025
45 checks passed
@TarantoolBot
Copy link
Collaborator

Successfully created backport PR for release/2.11:

@TarantoolBot
Copy link
Collaborator

Successfully created backport PR for release/3.2:

@TarantoolBot
Copy link
Collaborator

Successfully created backport PR for release/3.3:

@TarantoolBot
Copy link
Collaborator

Backport summary

@Totktonada Totktonada deleted the update-release-notes-template branch March 18, 2025 14:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/2.11 Automatically create a 2.11 backport PR backport/3.2 Automatically create a 3.2 backport PR backport/3.3 Automatically create a 3.3 backport PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants