Repository navigation
[TASK] Add a skill for Changelog-To-Doc issues - #642
Conversation
The skill typo3-docs-changelog in #642 covers Changelog-To-Doc issues from triage to the pull request. A second skill for the triage alone would compete with it. This pull request now only adds the triage rules to the page "Apply Changelog entries to the docs", where that skill can refer to them. Assisted-by: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Lina Wolf
|
I would suggest we use you skill and reduce #643 to only the doucmentation |
|
@linawolf One question for the review: which version should the version directive name for an entry in a patch-release folder such as The skill currently asks for the first release that contains the change, looked up in Gerrit. For Changelog-To-Doc#1903 that is
The check script reports a deviation only as a CHECK, not as a FIX. Either answer is a small change to Assisted by claude-code:claude-opus-5-5 — Session b8f5fb05-02a4-4932-9730-5833a75fc773 |
7587d4a to
a62151c
Compare
|
I tried the skill on #1933, #1926, #1929, and #1924 of Changelog-To-Doc. On your question: it depends on the folder. An entry from a Some points I found:
|
* [TASK] Add a skill that triages Changelog-To-Doc issues Every Core change with a changelog entry opens an issue in Changelog-To-Doc. Until now, the guide did not say how to decide whether such an issue needs documentation, which labels it gets, or what the comment has to say. A new section on the page "Apply Changelog entries to the docs" describes the three outcomes, the cases that need no documentation, the labels, and the comment. The skill applies these rules to one issue at a time: it reads the diff, searches all manuals, checks the permalinks, and shows the labels and the comment for approval before it posts anything. Assisted-by: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Lina Wolf * [TASK] Language checks * [TASK] Show one triage draft at a time The triage skill now says to show only the draft of the current issue, also when it researches several issues ahead, and no overview or count of the others. Assisted-by: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Lina Wolf * [TASK] Keep only the triage rules, drop the triage skill The skill typo3-docs-changelog in #642 covers Changelog-To-Doc issues from triage to the pull request. A second skill for the triage alone would compete with it. This pull request now only adds the triage rules to the page "Apply Changelog entries to the docs", where that skill can refer to them. Assisted-by: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Lina Wolf --------- Signed-off-by: Lina Wolf Co-authored-by: Sarah McCarthy <sarahmccarthy123@yahoo.com>
ec577f2 to
436480e
Compare
|
Thanks for trying it. The version rule you describe is what the skill and the check script already do: a Your three points are in 01f083a:
Assisted by claude-code:claude-opus-5-5 — Session b8f5fb05-02a4-4932-9730-5833a75fc773 |
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. For the triage, the skill refers to the section "Triage new issues" of the page about changelog entries. Its other rules come from review comments on recent changelog pull requests. The size limits of the check come from 40 merged changelog pull requests. The skill is added to the list of skills on the page about writing with AI assistance, which now says that this skill holds rules of its own. The skill is the first in this repository with tests and evals. The tests in tests/ run the scripts offline against three saved issues and a small git repository; run them with "python3 -m unittest discover -s skills/typo3-docs-changelog/tests". The evals in evals/evals.json give a model the output of changelog_issue.py for real issues and grade its answer with and without the skill. They use the format of the A/B runner of netresearch/skill-repo-skill. No workflow of this repository runs either of them. 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>
436480e to
01f083a
Compare
|
Thanks, all three points are fixed, and the tests run green here (92 tests, offline). Three more things, none of them blocking:
I would squash and merge without the Agent-Session and Agent-Host trailers, which are not part of our commit message rules. |
|
Thanks. Points 1 and 2 as follow-ups are fine with me; the skill can then refer to the guide for both. Squash without the two trailers is fine as well. On plugin.json: the plugin lists no skills, so a new folder under |
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.
For the triage, the skill refers to the section "Triage new issues" of the page about changelog entries. Its other rules come from review comments on recent changelog pull requests. The size limits of the check come from 40 merged changelog pull requests. The skill is added to the list of skills on the page about writing with AI assistance, which now says that this skill holds rules of its own.
The skill is the first in this repository with tests and evals. The tests in tests/ run the scripts offline against three saved issues and a small git repository; run them with "python3 -m unittest discover -s skills/typo3-docs-changelog/tests". The evals in evals/evals.json give a model the output of changelog_issue.py for real issues and grade its answer with and without the skill. They use the format of the A/B runner of netresearch/skill-repo-skill. No workflow of this repository runs either of them.
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