Release Strategy
Releases may align with:- Spring AI OSS releases
- Commercial product releases
- Independent schedules
Projects have full flexibility in their release timing and strategy.
Spring AI Team Support
The Spring AI Team can assist with:Repository Setup
Bootstrapping initial repositories
Project Templates
Providing a standardized project template
CI/CD Workflows
Setting up CI/CD workflows using GitHub Actions
Release Requirements
Semantic Versioning
Semantic Versioning
All projects must follow a clear Semantic Versioning (semver) scheme:
- MAJOR: Breaking changes
- MINOR: New features (backwards compatible)
- PATCH: Bug fixes (backwards compatible)
Passing CI/CD Pipeline
Passing CI/CD Pipeline
All tests and quality checks must pass before release
Documentation Updates
Documentation Updates
Documentation must reflect any new features, changes, or deprecations
Clear Changelog
Clear Changelog
A well-structured changelog describing what has changed
Maven Central Publication
Preferred Path
1
Use GitHub Actions
The preferred release path is via GitHub Actions in the community repository
2
Maven Central Publishing
Publish to Maven Central using GitHub-based publishing conventions
3
Use Standard GroupId
Artifacts should use the groupId
io.github.springaicommunity
Artifact Naming
- Artifact IDs (e.g.,
spring-ai-rag-helper
) may include dashes and should follow standard naming patterns - Root Java package names are flexible and up to the contributor, though they should follow common Spring conventions
This naming suggestion is specific to the GitHub-based Maven Central process. Project owners can use their own bespoke process and their own artifact IDs to publish to a public Maven repository.
The release templates for community-hosted repositories cannot use Spring’s internal Maven Central credentials — credential sharing is not permitted.