Index of every page on this site: llms.txt
All skills
Run it yourself

Verify a Spring Boot project before a pull request, large change, or release. Check the build, code rules, tests, coverage, known security flaws, format, and Git diff.

  • 1 file
  • 4.4 KB
  • Updated 2 months ago
  • GitHub
Use this Skill: https://skilld.dev/gh/agenticluke/spring-boot-check-plus/skill

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈44 tokens for metadata: the name and description. ≈1.1k when used: this file.

Description uses 2.4% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈193 characters, or 2.4%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

Spring Boot Check Loop

Run this before a pull request, after a large change, and before a release.

Use the build tool already used by the project. Prefer ./mvnw or ./gradlew when present. Do not add a new tool or plugin just to run this check.

Stop when a required check fails. Fix the cause, then run the failed check again.

1. Build

For Maven:

./mvnw -T 4 clean verify -DskipTests

For Gradle:

./gradlew clean assemble -x test

If there is no wrapper, use mvn or gradle.

2. Check Code Rules

Run only tasks that the project has.

For Maven:

./mvnw -T 4 spotbugs:check pmd:check checkstyle:check

For Gradle:

./gradlew checkstyleMain pmdMain spotbugsMain

A missing plugin is not a code failure. Mark that check as skipped and name the missing plugin.

3. Run Tests and Coverage

For Maven:

./mvnw -T 4 test
./mvnw jacoco:report

For Gradle:

./gradlew test jacocoTestReport

Check these items:

  • Total tests
  • Passed, failed, and skipped tests
  • Line coverage
  • Branch coverage
  • Failed test names

Use the coverage rule set by the project. If none exists, use 80% as a guide, not a hard rule.

Common report paths:

  • Maven tests: target/surefire-reports/
  • Maven coverage: target/site/jacoco/index.html
  • Gradle tests: build/reports/tests/test/index.html
  • Gradle coverage: build/reports/jacoco/test/html/index.html

If no tests exist, mark the test step as incomplete. Do not report it as passed.

4. Scan for Security Issues

Run a dependency scan only when the project has the OWASP plugin.

For Maven:

./mvnw org.owasp:dependency-check-maven:check

For Gradle:

./gradlew dependencyCheckAnalyze

Scan Git history for secrets only when git-secrets is set up:

git secrets --scan

Do not show secret values in the report. Show only the file name, line number, and type of issue.

A scan can fail due to a blocked download or old data. Report this as a scan error, not as proof that the project is safe.

5. Check Format

Use a check task when one exists:

./mvnw spotless:check
./gradlew spotlessCheck

Do not run a task that edits files unless the user asks for it. If asked, use:

./mvnw spotless:apply
./gradlew spotlessApply

After a format fix, run the tests again.

6. Review the Diff

Check both saved and staged changes:

git status --short
git diff --stat
git diff
git diff --cached

Look for:

  • Debug code such as System.out
  • Debug logs with no guard
  • Wrong or unclear HTTP status codes
  • Error text that does not help the user
  • Missing input checks
  • Missing or too-wide transactions
  • New config with no docs
  • Keys, passwords, or private data
  • Generated files that should not be saved
  • Test files that were disabled or removed
  • Database changes with no safe upgrade path

If the folder is not a Git repo, mark the diff check as skipped.

Example

A Maven project has mvnw, JaCoCo, Checkstyle, and Spotless. It does not have PMD or SpotBugs.

Run:

./mvnw -T 4 clean verify -DskipTests
./mvnw checkstyle:check
./mvnw -T 4 test
./mvnw jacoco:report
./mvnw spotless:check
git status --short
git diff --stat
git diff
git diff --cached

Mark PMD and SpotBugs as skipped. Do not try to add them.

Report

Verification Report
===================
Build:        [PASS / FAIL]
Code rules:   [PASS / FAIL / SKIPPED]
Tests:        [PASS / FAIL / INCOMPLETE]
              [X passed, Y failed, Z skipped]
Coverage:     [X% lines, Y% branches]
Security:     [PASS / FAIL / SCAN ERROR / SKIPPED]
Format:       [PASS / FAIL / SKIPPED]
Diff:         [X files changed]

Overall:      [READY / NOT READY]

Checks skipped:
1. [Check and reason]

Issues to fix:
1. [File and clear issue]
2. [File and clear issue]

Use READY only when all required checks pass. A skipped optional tool is allowed. A skipped required check is not allowed.

Keep Checking

After a large edit, run the full loop again.

During long work, run a short loop every 30 to 60 minutes:

./mvnw -T 4 test

Also run the code check used by the project. Treat warnings as failures when the project or release rules say so.

Source: SKILL.md on GitHub

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No third-party reports yet.

Signed by skilld at 8712845. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub last month.

Steadyupdated 2 months ago

README badge

README badge for agenticluke/spring-boot-check-plus