Repository navigation
Conversation
Documenting an issue of the Changelog-To-Doc repository takes the same lookups each time: the type and version of the changelog entry, the value for the :changelog: option, the manual and its branches, the pages that already mention the changed API, and how earlier issues about the same API were decided. Two of them are easy to miss: the issue title as the commit summary, and the patch release that shipped a 14.3.x entry. The skill typo3-docs-changelog runs two scripts. changelog_issue.py prints these facts for an issue, with the comments on it, the pull requests that already name it, and the first release per Core branch from Gerrit. check_changelog_change.py checks a finished change: the :changelog: identifier and its version, includes that are missing on a backport branch, sentences said twice, a patch version in the running text, the commit message, and the size of a Deprecation, Breaking, or Important change compared with earlier accepted changes. The rules of the skill come from the triage comments in the tracker and from review comments on recent changelog pull requests. The checks were run on 40 merged changelog pull requests and on the commits that reviewers commented on. The skill is added to the list of skills on the page about writing with AI assistance. Assisted-by: Claude Opus 5.5 <noreply@anthropic.com> Agent-Session: b8f5fb05-02a4-4932-9730-5833a75fc773 Agent-Host: 0493f0 Signed-off-by: Sebastian Mendel <info@sebastianmendel.de>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documenting an issue of the Changelog-To-Doc repository takes the same lookups each time: the type and version of the changelog entry, the value for the :changelog: option, the manual and its branches, the pages that already mention the changed API, and how earlier issues about the same API were decided. Two of them are easy to miss: the issue title as the commit summary, and the patch release that shipped a 14.3.x entry.
The skill typo3-docs-changelog runs two scripts. changelog_issue.py prints these facts for an issue, with the comments on it, the pull requests that already name it, and the first release per Core branch from Gerrit. check_changelog_change.py checks a finished change: the :changelog: identifier and its version, includes that are missing on a backport branch, sentences said twice, a patch version in the running text, the commit message, and the size of a Deprecation, Breaking, or Important change compared with earlier accepted changes.
The rules of the skill come from the triage comments in the tracker and from review comments on recent changelog pull requests. The checks were run on 40 merged changelog pull requests and on the commits that reviewers commented on. The skill is added to the list of skills on the page about writing with AI assistance.
Assisted-by: Claude Opus 5.5 noreply@anthropic.com
Agent-Session: b8f5fb05-02a4-4932-9730-5833a75fc773
Agent-Host: 0493f0
Signed-off-by: Sebastian Mendel info@sebastianmendel.de