Skip to content

Commit 847b70d

Browse files
dieppadieppa
committed
docs: springboot-integration only one artefact
1 parent 71e9b54 commit 847b70d

4 files changed

Lines changed: 25 additions & 58 deletions

File tree

‎docs/frameworks/springboot-integration/_category_.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"label": "Springboot",
2+
"label": "Spring Boot",
33
"position": 10,
44
"link": {
5-
"type": "doc",
6-
"id": "frameworks/springboot-integration/introduction"
5+
"type": "generated-index",
6+
"description": "Integrate Flamingock with Spring Boot applications for seamless change management."
77
}
88
}

‎docs/frameworks/springboot-integration/builder-based-setup.md‎

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,33 +15,21 @@ It’s especially useful when integrating Flamingock alongside other frameworks,
1515

1616
## Import the springboot integration library
1717

18-
Add the appropriate Flamingock Spring Boot integration dependency, depending on your version:
18+
Add the Flamingock Spring Boot integration dependency:
1919

2020
<Tabs groupId="gradle_maven">
2121
<TabItem value="gradle" label="Gradle">
2222
```kotlin
23-
// For Spring Boot 3.x
2423
implementation("io.flamingock:flamingock-springboot-integration:$flamingockVersion")
25-
26-
// For Spring Boot 2.x (legacy)
27-
implementation("io.flamingock:flamingock-springboot-integration-v2-legacy:$flamingockVersion")
2824
```
2925
</TabItem>
3026
<TabItem value="maven" label="Maven">
3127
```xml
32-
<!-- For Spring Boot 3.x -->
3328
<dependency>
3429
<groupId>io.flamingock</groupId>
3530
<artifactId>flamingock-springboot-integration</artifactId>
3631
<version>${flamingock.version}</version>
3732
</dependency>
38-
39-
<!-- For Spring Boot 2.x (legacy) -->
40-
<dependency>
41-
<groupId>io.flamingock</groupId>
42-
<artifactId>flamingock-springboot-integration-v2-legacy</artifactId>
43-
<version>${flamingock.version}</version>
44-
</dependency>
4533
```
4634
</TabItem>
4735
</Tabs>

‎docs/frameworks/springboot-integration/enable-flamingock-setup.md‎

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,40 +12,28 @@ Flamingock provides a convenient automatic integration with Spring Boot using th
1212

1313
## Import the springboot integration library
1414

15-
Add the appropriate Flamingock Spring Boot integration dependency, depending on your version:
15+
Add the Flamingock Spring Boot integration dependency:
1616

1717
<Tabs groupId="gradle_maven">
1818
<TabItem value="gradle" label="Gradle">
1919
```kotlin
20-
// For Spring Boot 3.x (Spring 6.x)
2120
implementation("io.flamingock:flamingock-springboot-integration:$flamingockVersion")
22-
23-
// For Spring Boot 2.x (Spring 5.x, legacy)
24-
implementation("io.flamingock:flamingock-springboot-integration-v2-legacy:$flamingockVersion")
2521
```
2622
</TabItem>
2723
<TabItem value="maven" label="Maven">
2824
```xml
29-
<!-- For Spring Boot 3.x (Spring 6.x) -->
3025
<dependency>
3126
<groupId>io.flamingock</groupId>
3227
<artifactId>flamingock-springboot-integration</artifactId>
3328
<version>${flamingock.version}</version>
3429
</dependency>
35-
36-
<!-- For Spring Boot 2.x (Spring 5.x, legacy) -->
37-
<dependency>
38-
<groupId>io.flamingock</groupId>
39-
<artifactId>flamingock-springboot-integration-v2-legacy</artifactId>
40-
<version>${flamingock.version}</version>
41-
</dependency>
4230
```
4331
</TabItem>
4432
</Tabs>
4533

4634
### Version Compatibility
4735

48-
Check [Version Compatibility](introduction.md#version-compatibility)
36+
The `flamingock-springboot-integration` artifact is compatible with both Spring Boot 2.x and 3.x. See [Version Compatibility](introduction.md#version-compatibility) for details.
4937

5038
## Configure setup and activate integration
5139

@@ -73,6 +61,20 @@ The `@EnableFlamingock` annotation enables automatic Spring Boot integration, wh
7361
- Processes the setup configuration from the annotation
7462

7563

64+
## Bean registration requirements
65+
66+
With automatic setup, Flamingock needs access to your target systems and (for Community Edition) audit stores. Since these aren't configured directly via the builder, they must be registered as Spring beans:
67+
68+
Example target system bean registration:
69+
```java
70+
@Bean
71+
public DefaultTargetSystem redisTargetSystem() {
72+
return new DefaultTargetSystem("redis-cache");
73+
}
74+
```
75+
76+
Flamingock will automatically detect and use these beans during execution.
77+
7678
## Providing configuration
7779

7880
Runtime configuration is defined using standard Spring Boot configuration files. Use the `flamingock` section for all core and edition-specific options.

‎docs/frameworks/springboot-integration/introduction.md‎

Lines changed: 5 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: Introduction
33
sidebar_position: 1
4-
sidebar_label: Spring Boot Introduction
54
---
65

76
import Tabs from '@theme/Tabs';
@@ -85,54 +84,32 @@ This behavior ensures your application only starts when all change units have be
8584

8685
## Dependency
8786

88-
To use the Spring Boot integration, add the appropriate module for your version:
87+
To use the Spring Boot integration, add the following dependency:
8988

9089
<Tabs groupId="gradle_maven">
9190
<TabItem value="gradle" label="Gradle">
9291
```kotlin
93-
// For Spring Boot 3.x
9492
implementation("io.flamingock:flamingock-springboot-integration:$flamingockVersion")
95-
96-
// For Spring Boot 2.x (legacy)
97-
implementation("io.flamingock:flamingock-springboot-integration-v2-legacy:$flamingockVersion")
9893
```
9994
</TabItem>
10095
<TabItem value="maven" label="Maven">
10196
```xml
102-
<!-- For Spring Boot 3.x -->
10397
<dependency>
10498
<groupId>io.flamingock</groupId>
10599
<artifactId>flamingock-springboot-integration</artifactId>
106100
<version>${flamingock.version}</version>
107101
</dependency>
108-
109-
<!-- For Spring Boot 2.x (legacy) -->
110-
<dependency>
111-
<groupId>io.flamingock</groupId>
112-
<artifactId>flamingock-springboot-integration-v2-legacy</artifactId>
113-
<version>${flamingock.version}</version>
114-
</dependency>
115102
```
116103
</TabItem>
117104
</Tabs>
118105

119106
### Version Compatibility
120107

121-
Flamingock provides two editions for Spring Boot integration.
122-
123-
### Why are there two Spring Boot integration artifacts?
124-
125-
The only difference is the Java version they target:
126-
127-
- `flamingock-springboot-integration` — requires JDK 17 or newer.
128-
- `flamingock-springboot-integration-v2-legacy` — kept for teams still on Spring Boot 2 who must stay on JDK 8 – 11.
129-
130-
Choose the artifact that matches the JDK level of your application today; switching later is as simple as changing the dependency.
108+
The `flamingock-springboot-integration` artifact is compatible with both Spring Boot 2.x and 3.x. Your project's Spring Boot version determines the appropriate Spring framework and JDK requirements.
131109

132-
| Package Name | Spring Boot Version |
133-
|------------------------------------------------|----------------------|
134-
| `flamingock-springboot-integration` | [3.0.0, 4.0.0) |
135-
| `flamingock-springboot-integration-v2-legacy` | [2.0.0, 3.0.0) |
110+
| Package Name | Spring Boot Version |
111+
|-------------------------------------|----------------------|
112+
| `flamingock-springboot-integration` | 2.x and 3.x |
136113

137114

138115
## :white_check_mark: Best practices

0 commit comments

Comments
 (0)