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: CHANGELOG.md
+11-1Lines changed: 11 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,21 @@
1
+
# Changes in v4 -> v5
2
+
3
+
* Thymeleaf default template location changed
4
+
*`kontent/ai/templates/`, `META-INF/kontent/ai/templates/` - you need to move your templates, use custom path configuration
5
+
* Namespaces of the packages we changed from `kentico.kontent.delivery.*` to `kontent.ai.delivery.*`
6
+
* Prefix for Kontent.ai exceptions has been changed from `Kentico` to `Kontent`:
7
+
*`KontentError`, `KontentErrorException`, `KontentException`, `KontentIOException`, and `KontentRetryException`
8
+
* Android Sample apps changed the application id prefix to "kontent.ai.*"
9
+
* Packages are signed by the new PGP key with id `A5992A24`
10
+
1
11
# Changes in v3 -> v4
2
12
3
13
* Delivery client now returns `CompletionStage` and it is async by default
4
14
* Internally [OkHttpClient](https://square.github.io/okhttp/4.x/okhttp/okhttp3/-ok-http-client/) is used to handle network requests
5
15
* Place for templates is by default
6
16
*`kentico/templates/`, `META-INF/kentico/templates/`, `kentico/kontent/templates/`, `META-INF/kentico/kontent/templates/` (last two are new)
7
17
* Retry codes are now set statically in DeliveryClient: `408, 429, 500, 502, 503, 504`
8
-
* If the retry response is not parsable to KenticoError.class - retry is not performed - https://docs.kontent.ai/reference/delivery-api#section/Errors/Resolving-errors
18
+
* If the retry response is not parsable to KenticoError.class - retry is not performed - https://kontent.ai/learn/reference/delivery-api#section/Errors/Resolving-errors
9
19
* Accessing linked items element data was simplified
|[Kontent Delivery Java SDK](/kontent-delivery#readme)| The Kontent Delivery Java SDK is a client library used for retrieving content from [Kontent by Kentico](https://kontent.ai)|[](https://bintray.com/kentico/kontent-java-packages/kontent-delivery/_latestVersion)|
14
-
|[Kontent Generators](/kontent-delivery-generators#readme)| This tool generates strongly-typed models based on Content Types in a Kontent project. |[](https://bintray.com/kentico/kontent-java-packages/kontent-delivery-generators/_latestVersion)|
15
-
|[Kontent Sample Spring Boot app](/sample-app-spring-boot#readme)| Showcase of the [Spring boot](https://spring.io/projects/spring-boot) application displaying data from Kontent. |[source](/sample-app-spring-boot/README.md)|
16
-
|[Kontent Sample Gradle Console app](/test-gradle-console-app#readme)| Simple Java console application showcasing how to load data from Kontent. |[source](/test-gradle-console-app/README.md)|
17
-
|[Kontent Sample Android app (Java)](/sample-app-android#readme)| Showcase of the [Android](https://www.android.com/) application written in Java using [RxJava](https://github.com/ReactiveX/RxJava) for data fetching from Kontent. |[source](/sample-app-android/README.md)|
18
-
|[Kontent Sample Android app (Kotlin)](/sample-app-android-kotlin#readme)| Showcase of the [Android](https://www.android.com/) application written in Kotlin using [Kotlin Coroutines](https://kotlinlang.org/docs/reference/coroutines-overview.html) for data fetching from Kontent. |[source](/sample-app-android-kotlin/README.md)|
|[Kontent.ai Delivery Java SDK](/delivery-sdk#readme)| The Kontent.ai Delivery Java SDK is a client library used for retrieving content from [Kontent.ai](https://kontent.ai)|[](https://s01.oss.sonatype.org/content/groups/public/ai/kontent/delivery-sdk/)|
13
+
|[Kontent.ai Generators](/delivery-sdk-generators#readme)| This tool generates strongly-typed models based on Content Types in a Kontent.ai project. |[](https://s01.oss.sonatype.org/content/groups/public/ai/kontent/delivery-sdk-generators)|
14
+
|[Kontent.ai Sample Spring Boot app](/sample-app-spring-boot#readme)| Showcase of the [Spring boot](https://spring.io/projects/spring-boot) application displaying data from Kontent.ai.|[source](/sample-app-spring-boot/README.md)|
15
+
|[Kontent.ai Sample Gradle Console app](/test-gradle-console-app#readme)| Simple Java console application showcasing how to load data from Kontent.ai.|[source](/test-gradle-console-app/README.md)|
16
+
|[Kontent.ai Sample Android app (Java)](/sample-app-android#readme)| Showcase of the [Android](https://www.android.com/) application written in Java using [RxJava](https://github.com/ReactiveX/RxJava) for data fetching from Kontent.ai.|[source](/sample-app-android/README.md)|
17
+
|[Kontent.ai Sample Android app (Kotlin)](/sample-app-android-kotlin#readme)| Showcase of the [Android](https://www.android.com/) application written in Kotlin using [Kotlin Coroutines](https://kotlinlang.org/docs/reference/coroutines-overview.html) for data fetching from Kontent.ai.|[source](/sample-app-android-kotlin/README.md)|
19
18
20
19
## Development
21
20
@@ -24,47 +23,67 @@ If you wish to find out more about the project specification. Check out the [Pro
24
23
### Prerequisites
25
24
26
25
**Required:**
27
-
Java 8 SDK (Oracle & OpenJDK both tested and supported)
26
+
27
+
- Java 8 SDK (Oracle & OpenJDK both tested and supported)
28
+
-[Android SDK](https://developer.android.com/studio#downloads) for the sample application (minimal version 28) - command line tools would be sufficient
- Enter the cloned repository and build the project via the provided Gradle wrapper.
46
+
- Copy `local.properties.template` file in this directory to `local.properties` (which will be ignored by Git)
47
+
48
+
- Set the `sdk.dir` variable Android SDK location
49
+
50
+
- Build the project via the provided Gradle wrapper.
39
51
40
52
> To grant execution rights for `gradlew` binary, you could use `chmod a+x ./gradlew` which allows execution to everybody.
41
53
42
54
```sh
43
-
cd kontent-java-packages
44
55
./gradlew clean build
45
56
```
46
57
47
58
> The command will build whole solution and run all tests in this monorepo.
48
59
49
60
#### :bulb: Next steps
50
61
51
-
The ideal next step is to test out the [Kontent Sample Spring Boot app](/sample-app-spring-boot#readme) or load the project in In IDE ([IntelliJ IDEA](https://www.jetbrains.com/idea/) recommended) and run/debug tests in [Kontent Delivery Java SDK](/kontent-delivery#readme).
62
+
The ideal next step is to test out the [Kontent.ai Sample Spring Boot app](/sample-app-spring-boot#readme) or load the
63
+
project in In IDE ([IntelliJ IDEA](https://www.jetbrains.com/idea/) recommended) and run/debug tests
64
+
in [Kontent.ai Delivery Java SDK](/delivery-sdk#readme).
52
65
53
66
## Publishing
54
67
55
-
> To publish a new version, it is required to have write permissions for this repository (to be able to create releases) and access to the [Nexus Repository Manager](https://oss.sonatype.org/).
56
-
68
+
> To publish a new version, it is required to have write permissions for this repository (to be able to create releases) and access to the [Nexus Repository Manager](https://s01.oss.sonatype.org/).
57
69
58
-
1. Verify that everything in the branch is ready to be published and the [build and tests](https://github.com/Kentico/kontent-java-packages/actions/workflows/gradle.yml) are passing.
70
+
1. Verify that everything in the branch is ready to be published and
71
+
the [build and tests](https://github.com/kontent-ai/java-packages/actions/workflows/gradle.yml) are passing.
59
72
1. Create new GitHub release - **the tag name of the release will be used as a version**
60
-
* If you define tag name with "-SNAPSHOT" suffix i.e. `4.4.0-SNAPSHOT` artifact will be published to the `https://oss.sonatype.org/content/repositories/snapshots/`, so that you could use it when you want to try out the beta version.
61
73
62
-
* The creation of a release triggers the [Publish Github workflow](https://github.com/Kentico/kontent-java-packages/actions/workflows/publish.yml) and creates and publishes the artifacts to "Staging" repositories on Nexus repository manager.
74
+
- If you define tag name with "-SNAPSHOT" suffix i.e. `5.0.0-SNAPSHOT` artifact will be published to
75
+
the `https://s01.oss.sonatype.org/content/repositories/snapshots/`, so that you could use it when you want to try out
76
+
the beta version.
77
+
78
+
- The creation of a release triggers
79
+
the [Publish Github workflow](https://github.com/kontent-ai/java-packages/actions/workflows/publish.yml) and
80
+
creates and publishes the artifacts to "Staging" repositories on Nexus repository manager.
63
81
64
-
1. Log in to the [Nexus Repository Manager](https://oss.sonatype.org/).
65
-
1. Select "Staging repositories", verify the repository content (*sometimes it takes a couple of minutes until the repository is visible in the Nexus Repository Manager UI*).
82
+
1. Log in to the [Nexus Repository Manager](https://s01.oss.sonatype.org/).
83
+
1. Select "Staging repositories", verify the repository content (_sometimes it takes a couple of minutes until the
84
+
repository is visible in the Nexus Repository Manager UI_).
66
85
1. Close the Staging repository
67
86
1. Release the Closed repository
68
87
1. Increase the patch version and append `-SNAPSHOT` in the bottom of `/build.gradle` file (i.e. `4.4.1-SNAPSHOT`).
69
88
70
-
> 💡 This is just an abbreviated description of the publishing process. If you want to see the detailed publishing description, checkout the [wiki page "Publishing process"](https://github.com/Kentico/kontent-java-packages/wiki/Release-process).
89
+
> 💡 This is just an abbreviated description of the publishing process. If you want to see the detailed publishing description, checkout the [wiki page "Publishing process"](./docs/Release-process.md).
0 commit comments