Skip to content

docs: document -Ppre-commit as auto-fixing, not a pass/fail check - #269

Merged
cuioss-oliver merged 1 commit into
mainfrom
chore/document-pre-commit-as-auto-fixing
Sep 9, 2026
Merged

cuioss-oliver merged 1 commit into
mainfrom
chore/document-pre-commit-as-auto-fixing

Conversation

@cuioss-oliver

Copy link
Copy Markdown
Collaborator

Aligns this repo's -Ppre-commit framing to what the command actually does.

-Ppre-commit is a formatter, not a pass/fail check. The profile inherited from cui-java-parent binds two mutating executions ahead of verify:

  • license:format (process-sources) — adds or updates license headers
  • rewrite:run (no declared phase → descriptor default process-test-classes) — applies the OpenRewrite recipes

Both run before verify, so a run that repaired the tree and a run that changed nothing both exit 0. Documenting it as a "check", "gate", or "quality verification" implies a green run means the tree was already clean — it does not. Empirically: strip a license header, run -Ppre-commit verify, and it exits 0 with the header silently restored and git status clean.

The corpus carried two contradictory framings. This aligns everything to: -Ppre-commit auto-fixes; review what it changed and commit it.

The reference wording is cuioss-parent-pom's own docs, which already say it correctly ("Adds or updates Apache 2.0 license headers…", "Applies all configured OpenRewrite recipes…") and are unchanged.

Note this is a documentation change only — no build behaviour changes. Auto-fixing is the intended org-wide norm, in every language.

🤖 Generated with Claude Code

-Ppre-commit rewrites tracked sources in place (license:format,
rewrite:run). Documenting it as a pass/fail 'check' or 'gate' misleads:
a run that repaired the tree and a run that changed nothing both exit 0.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@cuioss-oliver cuioss-oliver added the skip-bot-review Skip automated bot code review (Gemini/CodeRabbit/Sourcery) label Sep 9, 2026
@coderabbitai

coderabbitai Bot commented Sep 9, 2026 •

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are limited based on label configuration.

🚫 Excluded labels (none allowed) (1)
  • skip-bot-review

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository: cuioss/coderabbit/.coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 3403cacd-8b13-4493-8329-6ead609e36e3

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!

Sourcery assessment

Approved.


Sourcery is free for open source - if you like our reviews please consider sharing them ✨

@cuioss-oliver
cuioss-oliver added this pull request to the merge queue Sep 9, 2026
Merged via the queue into main with commit 01a4f63 Sep 9, 2026
21 checks passed
@cuioss-oliver
cuioss-oliver deleted the chore/document-pre-commit-as-auto-fixing branch September 9, 2026 07:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip-bot-review Skip automated bot code review (Gemini/CodeRabbit/Sourcery)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant