Document and localize Maven skip properties - #3009
Merged
Merged
Conversation
Move spotless.check.skip and spotless.apply.skip onto their respective mojos, keep spotless.skip on the shared base, and document all three properties in the Maven plugin README so check.skip is no longer mistaken for a global switch. Fixes diffplug#2981
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 513a3827d7
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
install-git-pre-push-hook does not read spotless.skip.
Member
|
This needs an entry in |
Contributor
Author
|
yep, added plugin-maven/CHANGES.md |
…perties # Conflicts: # plugin-maven/CHANGES.md
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
2 participants
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.
Fixes
Fixes #2981
Changes and Review
The Maven README only documented
spotless.check.skip, which made it look like a global switch.spotless.skipandspotless.apply.skipwere already implemented but undocumented.spotless.skip,spotless.check.skip, andspotless.apply.skip(scope + CLI/pom.xmlusage) in the Maven plugin README.SpotlessCheckMojo/SpotlessApplyMojo; keep goal-agnosticspotless.skipon the shared base.check.skipdoes not skip apply, and vice versa).Test Plan
./gradlew :plugin-maven:test --tests 'com.diffplug.spotless.maven.SpotlessCheckMojoTest'— 9/9 GREENPlease DO NOT FORCE PUSH. Don't worry about messy history.