Skip to content

chore(docs): prepare the 4.0.0 release - #11

Merged
notablogger merged 1 commit into
mainfrom
chore/prepare-release-4-0-0
Oct 26, 2026
Merged

notablogger merged 1 commit into
mainfrom
chore/prepare-release-4-0-0

Conversation

@notablogger

Copy link
Copy Markdown
Owner

Summary

Prepares main for the 4.0.0 release. The install instructions and the default version now say 4.0.0, and the documented release steps match what the release workflow actually does.

Type

  • 🐛 Bug fix
  • ✨ New feature / annotation attribute
  • ♻️ Refactor (no behaviour change)
  • 🧪 Tests only
  • 📝 Documentation only
  • 🔧 Build / CI change

Related issue

Follow-up to #6

What was changed

  • README.md: the Gradle (Groovy and Kotlin) and Maven install snippets now use 4.0.0 for spring-xpose-starter, -processor and -annotations. They said 3.0.1, which doesn't have search.
  • build.gradle: the default version is now 4.0.0. A local publishToMavenLocal without -PreleaseVersion no longer labels a 4.0 build as 3.0.1. CI publishing is unchanged, because it takes the version from the release tag.
  • CONTRIBUTING.md: the release steps now describe how release.yml actually works. It runs when a GitHub Release is published; pushing a vx.y.z tag on its own publishes nothing. The steps also cover what the workflow does: it takes the version from the tag, publishes the three artifacts to Maven Central, and attaches the JARs to the release.

How to test

  1. Run ./gradlew clean build -x javadoc. The JARs are named *-4.0.0.jar without passing -PreleaseVersion.
  2. Read the README install section and the CONTRIBUTING "Release Process" section.

Generated output (if applicable)

None. Generated code is unchanged.

Checklist

  • All existing tests pass (./gradlew :processor:test)
  • New tests added / updated to cover the change (not applicable: docs and the version default only)
  • No MapStruct warnings in the sample project (not applicable)
  • README.md updated if a public API / annotation attribute changed
  • docs/tech/ updated if architecture or generated artifacts changed (not applicable)
  • Commit messages follow type(scope): description format

Generated by Claude Code

- README install snippets (Gradle Groovy, Kotlin, Maven) point to 4.0.0.
- build.gradle's default version is 4.0.0, so local builds without
  -PreleaseVersion are labelled correctly.
- CONTRIBUTING: the release steps match release.yml, which publishes
  when a GitHub Release is published, not when a tag is pushed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LcaFXaRgJhB2GBCbwnAc6V
@notablogger
notablogger marked this pull request as ready for review October 26, 2026 13:33
@notablogger
notablogger merged commit ac09862 into main Oct 26, 2026
10 checks passed
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