Skip to content

[BUGFIX] Describe the commit-msg hook as reporting, not rejecting - #427

Merged
linawolf merged 1 commit into
TYPO3-Documentation:mainfrom
dkd-dobberkau:task/commit-msg-hook-does-not-block
Oct 9, 2026
Merged

linawolf merged 1 commit into
TYPO3-Documentation:mainfrom
dkd-dobberkau:task/commit-msg-hook-does-not-block

Conversation

@dkd-dobberkau

Copy link
Copy Markdown
Contributor

The commit-msg hook of the TYPO3 Core (Build/git-hooks/commit-msg) prints
an error box for a missing Resolves: line, an overlong line or a missing
keyword, but then still adds the Change-Id and exits successfully: the
commit is created anyway. The guide said the hook rejects such commits,
which can make contributors rely on it instead of reading its output.

Say that the hook reports and that its output must be read, point the
two links that went to the pre-commit hook to the commit-msg hook, and
name the commit-msg hook as the one adding the Change-Id.

Assisted-by: Claude Opus 5.5 noreply@anthropic.com
Signed-off-by: Olivier Dobberkau olivier.dobberkau@dkd.de

The commit-msg hook of the TYPO3 Core (Build/git-hooks/commit-msg) prints
an error box for a missing Resolves: line, an overlong line or a missing
keyword, but then still adds the Change-Id and exits successfully: the
commit is created anyway. The guide said the hook rejects such commits,
which can make contributors rely on it instead of reading its output.

Say that the hook reports and that its output must be read, point the
two links that went to the pre-commit hook to the commit-msg hook, and
name the commit-msg hook as the one adding the Change-Id.

Assisted-by: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Olivier Dobberkau <olivier.dobberkau@dkd.de>

@froemken froemken left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hi @dkd-dobberkau,

Thank you for this clarification.

Describing the actual behavior of the commit-msg hook is very helpful. Pointing out that it reports issues in the terminal without aborting the commit prevents contributors from overlooking required lines like Resolves:. Correcting the two cross-references to point to the commit-msg hook rather than the pre-commit hook is also a welcome fix.

The markup and line formatting are clean.

Best regards,
Stefan

@linawolf
linawolf merged commit 7628d94 into TYPO3-Documentation:main Oct 9, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants