From a53224361184e701b47087423a3958a5ef5d2383 Mon Sep 17 00:00:00 2001 From: Diane Gallois-Wong Date: Wed, 12 Nov 2025 14:05:51 +0100 Subject: [PATCH 1/6] Changelog/v24rc1: remove another misplaced entry See !19635; should have been done there --- docs/CHANGES.rst | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/CHANGES.rst b/docs/CHANGES.rst index c7c4df1da6f7..2a1f5a09f8df 100644 --- a/docs/CHANGES.rst +++ b/docs/CHANGES.rst @@ -120,10 +120,6 @@ DAL node a 500 error if querying a level at which the DAL was not supported instead of a 404 error. (MR :gl:`!19471`) -- **Breaking change** Enforced stricter validation for the JSON configuration - file. Previously, the parser would silently ignore any content that appeared - after the first valid JSON object. Now, any extraneous data will cause the - function to return an error. (MR :gl:`!18745`) Version 23.3 ============ -- GitLab From 7d31236cfe44b6f5a426b1089a6e8769e0ad5204 Mon Sep 17 00:00:00 2001 From: Diane Gallois-Wong Date: Wed, 12 Nov 2025 14:38:56 +0100 Subject: [PATCH 2/6] Changelog/v24rc1: expand entry on AI vote deprecation --- docs/CHANGES.rst | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/CHANGES.rst b/docs/CHANGES.rst index 2a1f5a09f8df..2ebf71a45b43 100644 --- a/docs/CHANGES.rst +++ b/docs/CHANGES.rst @@ -41,11 +41,13 @@ Node Baker ----- -- **Deprecation** The ``adaptive-issuance-vote`` argument (placeholder - ``vote``) is now deprecated, and will be removed in the next major - version of Octez. It was meant to decide the activation of the - Adaptive Issuance feature, and has had no effects since the Paris - protocol has been voted in. (MR :gl:`!19215`) +- **Deprecation** The optional baker argument + ``--adaptive-issuance-vote `` is now deprecated, and will be + removed in the next major version of Octez. It was meant to decide + the activation of the Adaptive Issuance feature, and has had no + effects since the Paris protocol has been voted in. The + ``adaptive_issuance_vote`` field of the per-block-vote configuration + file is similarly deprecated. (MR :gl:`!19215`) - **Deprecation** The ``octez-baker-`` binaries are deprecated, and will be removed in the next major version of -- GitLab From 2607d7b2b641852df045dc97fdc13f5983b080e2 Mon Sep 17 00:00:00 2001 From: Diane Gallois-Wong Date: Wed, 12 Nov 2025 14:34:37 +0100 Subject: [PATCH 3/6] Docs/breaking_changes: fill in Octez v24 section --- docs/introduction/breaking_changes.rst | 79 ++++++++++++++++++++++++-- 1 file changed, 75 insertions(+), 4 deletions(-) diff --git a/docs/introduction/breaking_changes.rst b/docs/introduction/breaking_changes.rst index 2db5647d9d45..c022fc47e535 100644 --- a/docs/introduction/breaking_changes.rst +++ b/docs/introduction/breaking_changes.rst @@ -17,6 +17,81 @@ that may be breaking. In the particular case of RPC changes, you may consult complementary information on :ref:`RPC versioning `, covering how new versions are introduced, the deprecation policy, and a concrete calendar of RPCs planned to be removed. +.. _v24_breaking_changes: + +Octez Version 24 +---------------- + +:doc:`Full Octez Version 24 Changelog<../releases/version-24>` + +Deprecation of protocol-specific bakers and accusers +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Octez v24 deprecates the ``octez-baker-`` and +``octez-accuser-`` binaries. They will be removed in a +future version. Please use the protocol-independent binaries +``octez-baker`` and ``octez-accuser`` instead, which automatically +handle protocol switches. + + +Deprecation of Adaptive Issuance vote in the baker +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Octez v24 deprecates the optional argument ``--adaptive-issuance-vote +`` of the baker. This argument will be removed in a future +version. It was meant to decide the activation of the Adaptive +Issuance feature, and has had no effects since the Paris protocol has +been voted in, so it can already be removed without any impact on the +baker. + +The ``adaptive_issuance_vote`` field of the per-block-vote +configuration file is similarly deprecated. + + +Node events +^^^^^^^^^^^ + +As of Octez v24, the following node events contain the short hash of +blocks instead of the full hash: + +- from the block validator: events + ``validation_or_application_failed``, ``application_failed``, + ``application_failure_after_validation``, ``validation_failure``, + ``validation_canceled``, ``commit_block_failure``, + ``validated_block``, ``validation_and_application_success`` and + ``updated_to_checkpoint``, + +- from the prevalidator: event ``request_completed_info``, + +- and from the store: `` (level: )`` has become + `` (level: )``. + +The level of event ``validator.block.validating_block`` has changed +from ``Debug`` to ``Info``, so it now appears in the daily logs by +default. Moreover, this event now shows the long block hash, level, +predecessor, fitness, and timestamp of the block. + +The level of event ``validator.chain.block_info`` has changed from +``Info`` to ``Debug``, so it no longer appears in the daily logs by +default. + + +DAL node RPCs +^^^^^^^^^^^^^ + +As of Octez v24, the +``/levels//slots//status`` RPC answers with +``unpublished`` status for unpublished slots instead of a 404 empty +response. + +Slots status are not stored in dedicated files on disk anymore, but +found in a cache and the skip list. A consequence of this is that the +``/levels//slots//status`` RPC now only works +with nodes that store the skip list, and therefore not with observer +nodes. Also, the RPC now answers with a 500 error if querying a level +at which the DAL was not supported, instead of a 404 error. + + .. _tallinn_breaking_changes: @@ -126,10 +201,6 @@ omitted in cache functions. As a result, gas costs for smart contract calls has increased by at most 2 units of gas each time the cache is accessed. -.. _v24_breaking_changes: - -Octez Version 24 ----------------- .. _v23_breaking_changes: -- GitLab From 7c93c939f53cfa58277969e87bd601a5308c673e Mon Sep 17 00:00:00 2001 From: Diane Gallois-Wong Date: Wed, 12 Nov 2025 15:11:27 +0100 Subject: [PATCH 4/6] Docs/breaking_changes: improve introduction --- docs/introduction/breaking_changes.rst | 59 +++++++++++++++++--------- 1 file changed, 40 insertions(+), 19 deletions(-) diff --git a/docs/introduction/breaking_changes.rst b/docs/introduction/breaking_changes.rst index c022fc47e535..f8964a0947bd 100644 --- a/docs/introduction/breaking_changes.rst +++ b/docs/introduction/breaking_changes.rst @@ -6,16 +6,35 @@ between successive protocols or successive Octez versions. It complements the respective :ref:`protocol changelogs ` and :doc:`Octez changelog <../CHANGES>` by gathering all breaking changes in one place and providing more context -when appropriate. +when appropriate. Deprecated features are also presented here. -For each change, there may be subsections ``Deprecation`` and ``Breaking -changes``. The former subsection will explain what changes can be made during a -deprecation phase to adapt smoothly to the new changes. The latter subsection -will present the changes that can not be done by the deprecation mechanism and -that may be breaking. +In the particular case of RPC changes, you may consult complementary +information on :ref:`RPC versioning `, covering how +new versions are introduced, the deprecation policy, and a concrete +calendar of RPCs planned to be removed. -In the particular case of RPC changes, you may consult complementary information on :ref:`RPC versioning `, covering how new versions are introduced, the deprecation policy, and a concrete calendar of RPCs planned to be removed. +This page contains the breaking changes and deprecated features of +current or recent protocols, protocol proposals, and Octez versions: +- :ref:`tallinn_breaking_changes` +- :ref:`seoul_breaking_changes` +- :ref:`v24_breaking_changes` +- :ref:`v23_breaking_changes` +- :ref:`v22_breaking_changes` + +as well as a preview of future breaking changes and deprecated +features in upcoming releases: + +- :ref:`alpha_breaking_changes` +- :ref:`octez_dev_breaking_changes` + +For features deprecated or broken in older protocols and Octez +versions, see :doc:`deprecated`. + +.. toctree:: + :hidden: + + deprecated .. _v24_breaking_changes: @@ -296,6 +315,8 @@ This proof may be generated using the client command:: octez-client create bls proof for +.. _v22_breaking_changes: + Octez Version 22 ---------------- @@ -311,30 +332,30 @@ Starting from Octez ``v22``, launching a baker daemon requires an explicit menti The recommended approach is to run a DAL node and start the baker using the ``--dal-node `` option. If you do not wish to use a DAL node, you can opt-out by using the ``--without-dal`` option. -Older changes -------------- -For features deprecated or broken in older Octez versions and protocols, see :doc:`deprecated`. -.. toctree:: - :hidden: - - deprecated - -Upcoming changes +Upcoming Changes ================ .. warning:: Changes described in this section concern code that has been merged into the master branch but **has not been released yet**! They are meant as a heads-up for developers wanting to known in advance how future releases and protocols may impact developers and users. + Note that they may also be modified or discarded before being released. -Upcoming release ----------------- +.. _octez_dev_breaking_changes: + +Upcoming Octez Release +---------------------- N/A -Development protocol Alpha + +.. _alpha_breaking_changes: + +Development Protocol Alpha -------------------------- +:doc:`Full Protocol Alpha Changelog<../protocols/alpha>` + N/A -- GitLab From b7c5b5a775fc0e2a6689492fb44899e389c60450 Mon Sep 17 00:00:00 2001 From: Diane Gallois-Wong Date: Wed, 12 Nov 2025 15:15:24 +0100 Subject: [PATCH 5/6] Docs: rename deprecated to past_breaking_changes --- docs/introduction/breaking_changes.rst | 4 ++-- .../{deprecated.rst => past_breaking_changes.rst} | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) rename docs/introduction/{deprecated.rst => past_breaking_changes.rst} (98%) diff --git a/docs/introduction/breaking_changes.rst b/docs/introduction/breaking_changes.rst index f8964a0947bd..278e5b8a5a18 100644 --- a/docs/introduction/breaking_changes.rst +++ b/docs/introduction/breaking_changes.rst @@ -29,12 +29,12 @@ features in upcoming releases: - :ref:`octez_dev_breaking_changes` For features deprecated or broken in older protocols and Octez -versions, see :doc:`deprecated`. +versions, see :doc:`past_breaking_changes`. .. toctree:: :hidden: - deprecated + past_breaking_changes .. _v24_breaking_changes: diff --git a/docs/introduction/deprecated.rst b/docs/introduction/past_breaking_changes.rst similarity index 98% rename from docs/introduction/deprecated.rst rename to docs/introduction/past_breaking_changes.rst index 615af45f75e0..ec01e6e86e5a 100644 --- a/docs/introduction/deprecated.rst +++ b/docs/introduction/past_breaking_changes.rst @@ -1,5 +1,5 @@ -Deprecated features -=================== +Past Breaking Changes and Deprecated Features +============================================= This page list breaking changes and deprecated features in old Octez versions and protocols, that are normally no longer being run. -- GitLab From a4bc4747311e9748932dfb96fda64704526e9057 Mon Sep 17 00:00:00 2001 From: Diane Gallois-Wong Date: Wed, 12 Nov 2025 14:34:37 +0100 Subject: [PATCH 6/6] Docs/breaking_changes & Changelog/Octez-dev: add instructions --- CHANGES.rst | 7 +++++++ docs/introduction/breaking_changes.rst | 16 ++++++++++++++++ 2 files changed, 23 insertions(+) diff --git a/CHANGES.rst b/CHANGES.rst index 9bf5e3280eeb..b3cec2f35584 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -22,6 +22,13 @@ or which will affect users in the future (deprecated features), not refactorings or tests. Changes to the documentation do not need to be documented here either. +Breaking changes and deprecated features should be prefixed with the +appropriate tag **Breaking change** or **Deprecation**, and also added +to the breaking changes page in +``docs/introduction/breaking_changes.rst``, section "Upcoming Octez +Release". + + General ------- diff --git a/docs/introduction/breaking_changes.rst b/docs/introduction/breaking_changes.rst index 278e5b8a5a18..e6f21e319454 100644 --- a/docs/introduction/breaking_changes.rst +++ b/docs/introduction/breaking_changes.rst @@ -348,6 +348,22 @@ Upcoming Changes Upcoming Octez Release ---------------------- +.. This section gathers the breaking changes and deprecations listed + in the development changelog: + https://octez.tezos.com/docs/CHANGES-dev.html (file CHANGES.rst at + the root of the tezos repository) -- not to be confused with the + released changelog https://octez.tezos.com/docs/CHANGES.html (file + docs/CHANGES.rst) + + When releasing the changes described here, don't forget to: + - move them to a new section "Octez Version X" at the top of this page + - add a link to the new "releases/version-X" page, cf other sections + - in the introduction of the current page, add a link to the new section + - update tense used to present/past if needed + - reset the content of the "Upcoming Octez Release" section to just + "N/A" (unless there are already changes planned for the version + after the newly released one, of course) + N/A -- GitLab