Skip to content

[rewrite] fix GradleBestPractices#2727

Closed
Pankraz76 wants to merge 1 commit into
diffplug:mainfrom
Pankraz76:fix-GradleBestPractices
Closed

[rewrite] fix GradleBestPractices#2727
Pankraz76 wants to merge 1 commit into
diffplug:mainfrom
Pankraz76:fix-GradleBestPractices

Conversation

@Pankraz76

Copy link
Copy Markdown

Please DO NOT FORCE PUSH. Don't worry about messy history, it's easier to do code review if we can tell what happened after the review, and force pushing breaks that.

Please make sure that your PR allows edits from maintainers. Sometimes it's faster for us to just fix something than it is to describe how to fix it.

Allow edits from maintainers

After creating the PR, please add a commit that adds a bullet-point under the [Unreleased] section of CHANGES.md, plugin-gradle/CHANGES.md, and plugin-maven/CHANGES.md which includes:

  • a summary of the change
  • either
    • a link to the issue you are resolving (for small changes)
    • a link to the PR you just created (for big changes likely to have discussion)

If your change only affects a build plugin, and not the lib, then you only need to update the plugin-foo/CHANGES.md for that plugin.

If your change affects lib in an end-user-visible way (fixing a bug, updating a version) then you need to update CHANGES.md for both the lib and all build plugins. Users of a build plugin shouldn't have to refer to lib to see changes that affect them.

This makes it easier for the maintainers to quickly release your changes :)

@Pankraz76 Pankraz76 changed the title [rewrite] Add GradleBestPractices [rewrite] fix GradleBestPractices Nov 17, 2025
Signed-off-by: Vincent Potucek <vpotucek@me.com>
@Pankraz76 Pankraz76 force-pushed the fix-GradleBestPractices branch from 5a7115d to 5547f17 Compare November 17, 2025 14:20
validateDistributionUrl=true
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
distributionSha256Sum=72f44c9f8ebcb1af43838f45ee5c4aa9c5444898b3468ab3f4af7b6076c5bc3f

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Comment thread build.gradle
apply from: rootProject.file('gradle/rewrite.gradle')
apply from: rootProject.file('gradle/spotless-freshmark.gradle')

spotless {

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

is this possible to move and merge with the dedicated project config?

or do we need this to be divided?

Comment thread build.gradle
@Pankraz76 Pankraz76 marked this pull request as ready for review November 17, 2025 16:02

@nedtwigg nedtwigg left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This is changing too many things at once. Please only change one thing at a time.

Comment thread build.gradle
Comment on lines -11 to 19

apply from: rootProject.file('gradle/java-publish.gradle')
apply from: rootProject.file('gradle/changelog.gradle')
allprojects {
apply from: rootProject.file('gradle/error-prone.gradle')
apply from: rootProject.file('gradle/rewrite.gradle')
apply from: rootProject.file('gradle/spotless.gradle')
}
apply from: rootProject.file('gradle/changelog.gradle')
apply from: rootProject.file('gradle/java-publish.gradle')
apply from: rootProject.file('gradle/rewrite.gradle')
apply from: rootProject.file('gradle/spotless-freshmark.gradle')

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

  • before: java-publish, then changelog, then allprojects
  • after: allprojects, then changelog, then java-publish

That's a risky change. I think they depend on each other, but it takes time to confirm, and we won't notice it's broken until a publish fails. Try to make your PR's more focused on a single change and they are easier to merge.

@nedtwigg nedtwigg closed this Nov 18, 2025
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.

2 participants