You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/templates/create-your-own-template.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,20 +17,20 @@ While official Flamingock templates are experimental, you can already build and
17
17
18
18
## Dependency
19
19
20
-
Creating a template requires the `flamingock-core-api` artifact on the classpath. This dependency is transitively included by the core Flamingock library, so you only need to declare it explicitly when the template lives in its own dedicated module (e.g., a reusable template library):
20
+
Creating a template requires the `flamingock-template-api` artifact on the classpath. This dependency is transitively included by the core Flamingock library, so you only need to declare it explicitly when the template lives in its own dedicated module (e.g., a reusable template library):
Copy file name to clipboardExpand all lines: docs/templates/templates-how-to-use.md
+25-6Lines changed: 25 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,31 +15,50 @@ Using a Flamingock Template is straightforward. Here's an example of how you can
15
15
This section uses the **SQL Template** as example.
16
16
:::
17
17
18
-
## Step 1: Add the Template dependency
18
+
## Step 1: Add the template dependency
19
19
20
-
Ensure your **Flamingock Template** dependency is included in your project. Example of using `sql-template`:
20
+
How you set up the dependency depends on where the template comes from.
21
+
22
+
### Official Flamingock templates
23
+
24
+
Official templates are included in the Flamingock Gradle plugin and the BOM, so no version management is needed. For example, to use the SQL Template:
21
25
22
26
<TabsgroupId="gradle_maven">
23
27
<TabItemvalue="gradle"label="Gradle">
24
28
```kotlin
25
-
importio.flamingock.gradle.FlamingockTemplate.SQL
26
-
27
29
flamingock {
28
30
//...
29
-
templates(SQL)
31
+
sql()
30
32
}
31
33
```
32
34
</TabItem>
33
35
<TabItemvalue="maven"label="Maven">
36
+
37
+
Requires the [Flamingock BOM](../get-started/quick-start.md) in your `<dependencyManagement>` section. Then add the template dependency without a version:
Each official template has its own plugin function (`sql()`, `mongodb()`, etc.) and BOM-managed artifact. See the individual template reference pages for the exact setup.
49
+
50
+
### Third-party or community templates
51
+
52
+
For templates published by third parties, add them as a standard dependency:
If the template is defined within your own project, no additional dependency is needed — Flamingock discovers it automatically via [ServiceLoader registration](./create-your-own-template.md#3-register-the-template-with-serviceloader).
61
+
43
62
## Step 2: Create the change file
44
63
45
64
Template-based changes are defined in **YAML files** placed inside your application's resources directory. Each file represents a single change.
0 commit comments