Skip to content

Update pre-commit workflow set --show-diff-on-failure#2487

Merged
lprimak merged 1 commit intoapache:mainfrom
jbampton:pre-commit-diff-on-failure
Jan 31, 2026
Merged

Update pre-commit workflow set --show-diff-on-failure#2487
lprimak merged 1 commit intoapache:mainfrom
jbampton:pre-commit-diff-on-failure

Conversation

@jbampton
Copy link
Member

Without this flag, when a hook fails because it modified files, pre-commit will simply indicate that files were modified and the hook failed, without showing the specific changes. The developer would then have to manually run git diff or inspect the files to see what happened

Following this checklist to help us incorporate your contribution quickly and easily:

  • Make sure there is a GitHub issue filed
    for the change (usually before you start working on it). Trivial changes like typos do not
    require a GitHub issue. Your pull request should address just this issue, without pulling in other changes.
  • Format the pull request title like [#XXX] - Fixes bug in SessionManager,
    where you replace #XXX with the appropriate GitHub issue. Best practice
    is to use the GitHub issue title in the pull request title and in the first line of the commit message.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • add fixes #XXX if merging the PR should close a related issue.
  • Run mvn verify to make sure basic checks pass. A more thorough check will be performed on your pull request automatically.
  • Committers: Make sure a milestone is set on the PR
  • Committers: Use "Squash and Merge" to combine all commits into one when merging a PR when appropriate.

Trivial changes like typos do not require a GitHub issue (javadoc, comments...).
In this case, just format the pull request title like [DOC] - Add javadoc in SessionManager.

If this is your first contribution, you have to read the Contribution Guidelines

If your pull request is about ~20 lines of code you don't need to sign an Individual Contributor License Agreement
if you are unsure please ask on the developers list.

To make clear that you license your contribution under the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

Without this flag, when a hook fails because it modified files, pre-commit will simply indicate that files were modified and the hook failed,
without showing the specific changes. The developer would then have to manually run git diff or inspect the files to see what happened
@github-actions github-actions bot added the github_actions Pull requests that update GitHub Actions code label Jan 31, 2026
@lprimak lprimak merged commit f27f46e into apache:main Jan 31, 2026
29 of 31 checks passed
@jbampton jbampton deleted the pre-commit-diff-on-failure branch January 31, 2026 20:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

github_actions Pull requests that update GitHub Actions code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants