Skip to content

[FEATURE] Document the :changelog: option of the version directives #571

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.

Sign up for GitHub

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
linawolf merged 3 commits into from
Oct 1, 2026
Merged

[FEATURE] Document the :changelog: option of the version directives #571

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5a25848
[FEATURE] Document the :changelog: option of the version directives
CybotTM Sep 17, 2026
2c03517
[TASK] Fix the house style of the :changelog: section
CybotTM Sep 17, 2026
5f5f9e9
[TASK] Show the rendered :changelog: option and keep to Core entries
CybotTM Sep 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions Documentation/Reference/ReStructuredText/Content/Versions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,3 +123,34 @@ Find a changelog entry's permalink from its own
`.. _<type>-<issue>-<timestamp>:` anchor, for example in the "Added files"
section of the corresponding `Changelog-To-Doc <https://github.com/TYPO3-Documentation/Changelog-To-Doc>`__
issue.

.. _rest-versions-changelog-option:

Linking the changelog entry with `:changelog:`
==============================================

The examples above write the permalink of the changelog entry by hand into
the directive body. The three version directives also accept the
:rst:`:changelog:` option. Use this option to link an entry of the TYPO3
Core changelog. The value is the identifier of the entry, in the form
`<type>-<issue>-<timestamp>`:

.. code-block:: rst

.. versionchanged:: 14.0
:changelog: feature-107628-1729026000

Most modules moved from :guilabel:`System` to
:guilabel:`Administration`.

Comment thread
CybotTM marked this conversation as resolved.
.. versionchanged:: 14.0
:changelog: feature-107628-1729026000

Most modules moved from :guilabel:`System` to
:guilabel:`Administration`.

The option puts the link into the version badge. The link text is the title
of the changelog entry, so you do not copy the title and the URL by hand.

If the identifier does not match an entry, the rendering shows a warning.
Check the identifier before you commit the change.
Loading