Document how to run style/static-analysis checks locally - #4452
Draft
arnaud-lacurie wants to merge 2 commits into
Draft
arnaud-lacurie wants to merge 2 commits into
arnaud-lacurie wants to merge 2 commits into
Conversation
Adds a "Style / static analysis checks" section to the using-gradle skill (CI-parity command, report locations, common violations seen when hand-resolving merge conflicts) and a PR Workflow reminder to run it before pushing.
robert-brunel
left a comment
robert-brunel
left a comment
Contributor
There was a problem hiding this comment.
In my opinion, some of these guidelines would be good to put in the general public Building.md guide for every developer (from where agents can then presumably just pick them up just as well).
The documented style-check command was missing -PreleaseBuild=false -PpublishBuild=false, which CI's style job actually passes -- running without them can hide failures that only reproduce under the real flags. Also documents two SpotBugs quirks hit while rolling out jspecify module-by-module: missing-annotation-class analysis failures across compileOnly boundaries, and NP_METHOD_PARAMETER_TIGHTENS_ANNOTATION false positives between mixed annotation libraries.
This branch has not been deployed
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.
Summary
using-gradleskill: the CI-paritycommand (matching
.github/workflows/pull_request.yml'sstylejob), report locations,and a couple of common Checkstyle/PMD violations that show up when hand-resolving merge
conflicts (redundant same-package imports, unnecessary fully-qualified names).
AGENTS.mdto run these checks before pushing.Motivated by hitting exactly these violations while manually rebasing a stack of PRs across a
few months of upstream drift — nothing in the skills documented how to reproduce CI's style
check locally, so it wasn't caught until CI ran.
Test plan