Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate to new organization #141

Merged
merged 42 commits into from
Oct 24, 2022
Merged
Show file tree
Hide file tree
Changes from 25 commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
45d607f
rename delivery module
Simply007 Sep 26, 2022
3c08e61
replace base namespace
Simply007 Sep 26, 2022
41cac52
replace base namespace for delivery generators
Simply007 Sep 26, 2022
eb7241d
rename delivery to delivery-sdk
Simply007 Sep 26, 2022
45c8549
rename generators to delivery-sdk-generators
Simply007 Sep 26, 2022
72822c3
first batch of non-functional renaming
Simply007 Sep 26, 2022
6175c7e
fix up application id for core packages
Simply007 Sep 27, 2022
c66b941
fix readme table
Simply007 Sep 27, 2022
f05a613
fix discord badge
Simply007 Sep 27, 2022
618c287
adjust puglic GPG key
Simply007 Sep 30, 2022
9315e7a
fix server and namesapces
Simply007 Oct 3, 2022
e53c4a8
finish springboot app migration
Simply007 Oct 3, 2022
04c35f1
migrate console app
Simply007 Oct 3, 2022
3187d6d
adjust android app
Simply007 Oct 3, 2022
e8d6dae
migrate kotlin sample app
Simply007 Oct 3, 2022
13dfec3
rest mantionf of Kentico
Simply007 Oct 3, 2022
285422b
refromat file
Simply007 Oct 3, 2022
3c362c8
migrate wiki
Simply007 Oct 4, 2022
be8d4c3
move adpoid plugin only for android apps
Simply007 Oct 6, 2022
813e81f
fix prerequisites
Simply007 Oct 7, 2022
eb67e47
fix links
Simply007 Oct 7, 2022
f6b3511
fix copyrights
Simply007 Oct 7, 2022
631f8e7
fix links to cross the wiki
Simply007 Oct 7, 2022
64edaab
Revert "move adpoid plugin only for android apps"
Simply007 Oct 7, 2022
fbb829d
remove unnecesary dependency (been included in parent project)
Simply007 Oct 7, 2022
ecce283
Update sample-app-android/src/main/res/values/strings.xml
Simply007 Oct 18, 2022
7b01a81
Update README.md
Simply007 Oct 18, 2022
0f3fe61
Update delivery-sdk/README.md
Simply007 Oct 18, 2022
632d9b1
Update delivery-sdk/README.md
Simply007 Oct 18, 2022
5a538dd
finish Kontent.ai rename
Simply007 Oct 20, 2022
752d9a8
rename docs.kontent.ai to learn URL
Simply007 Oct 20, 2022
16d5ad4
fix test
Simply007 Oct 20, 2022
5c073c0
fix some TODO comments
Simply007 Oct 20, 2022
ec4112d
remove extra empty line
Simply007 Oct 20, 2022
f7f19be
fix filename
Simply007 Oct 20, 2022
de73f64
replace font
Simply007 Oct 20, 2022
54c1e4d
remove forgottent folder
Simply007 Oct 20, 2022
820e886
add URL link resolution
Simply007 Oct 20, 2022
7c05b57
format date of article
Simply007 Oct 20, 2022
5204f05
Remove floating action button
Oct 24, 2022
ce5d99a
fix forgotten rebranding
Simply007 Oct 24, 2022
668a13f
use delombok for Asset.java
Simply007 Oct 24, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions .idea/compiler.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 10 additions & 0 deletions kontent-delivery/CHANGES.md → CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
# Changes in v4 -> v5

* Thymeleaf default template location changed
* `kontent/ai/templates/`, `META-INF/kontent/ai/templates/` - you need to move your templates, use custom path configuration
* Namespaces of the packages we changed from `kentico.kontent.delivery.*` to `kontent.ai.delivery.*`
* Prefix for Kontent.ai exceptions has been changed from `Kentico` to `Kontent`:
* `KontentError`, `KontentErrorException`, `KontentException`, `KontentIOException`, and `KontentRetryException`
* Android Sample apps changed the application id prefix to "kontent.ai.*"
* Packages are signed by the new PGP key with id `A5992A24`

# Changes in v3 -> v4

* Delivery client now returns `CompletionStage` and it is async by default
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2020 Kentico
Copyright (c) 2022 Kontent s.r.o.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
70 changes: 44 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,20 @@
# Kontent Java Packages
# Kontent.ai Java Packages

[![GitHub Discussions](https://img.shields.io/badge/GitHub-Discussions-FE7A16.svg?style=popout&logo=github)](https://github.com/Kentico/Home/discussions)
[![Stack Overflow](https://img.shields.io/badge/Stack%20Overflow-ASK%20NOW-FE7A16.svg?logo=stackoverflow&logoColor=white)](https://stackoverflow.com/tags/kentico-kontent)
[![Discord](https://img.shields.io/discord/821885171984891914?label=Discord&logo=Discord&logoColor=white)](https://discord.gg/SKCxwPtevJ)
[![Stack Overflow](https://img.shields.io/badge/Stack%20Overflow-ASK%20NOW-FE7A16.svg?logo=stackoverflow&logoColor=white)](https://stackoverflow.com/tags/kontent-ai)
[![Discord](https://img.shields.io/discord/821885171984891914?color=%237289DA&label=Kontent.ai%20Discord&logo=discord)](https://discord.gg/SKCxwPtevJ)

Monorepo with Java Kontent packages.
Monorepo with Java Kontent.ai packages.

## Packages

| Package | Summary | Version |
| :----------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| [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) | [![Download](https://api.bintray.com/packages/kentico/kontent-java-packages/kontent-delivery/images/download.svg)](https://bintray.com/kentico/kontent-java-packages/kontent-delivery/_latestVersion) |
| [Kontent Generators](/kontent-delivery-generators#readme) | This tool generates strongly-typed models based on Content Types in a Kontent project. | [![Download](https://api.bintray.com/packages/kentico/kontent-java-packages/kontent-delivery-generators/images/download.svg)](https://bintray.com/kentico/kontent-java-packages/kontent-delivery-generators/_latestVersion) |
| [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) |
| [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) |
| [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) |
| [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) |
| Package | Summary | Version |
| :-------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| [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) | [![Maven Central](https://img.shields.io/maven-central/v/ai.kontent/delivery-sdk)](https://s01.oss.sonatype.org/content/groups/public/ai/kontent/delivery-sdk/) |
| [Kontent.ai Generators](/delivery-sdk-generators#readme) | This tool generates strongly-typed models based on Content Types in a Kontent.ai project. | [![Maven Central](https://img.shields.io/maven-central/v/ai.kontent/delivery-sdk-generators)](https://s01.oss.sonatype.org/content/groups/public/ai/kontent/delivery-sdk-generators) |
| [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) |
| [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) |
| [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) |
| [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) |

## Development

Expand All @@ -24,47 +23,66 @@ If you wish to find out more about the project specification. Check out the [Pro
### Prerequisites

**Required:**
Java 8 SDK (Oracle & OpenJDK both tested and supported)

- Java 8 SDK (Oracle & OpenJDK both tested and supported)
- [Android SDK](https://developer.android.com/studio#downloads) for the sample application (minimally version 28) - command line tools would be sufficient
Simply007 marked this conversation as resolved.
Show resolved Hide resolved

### Build and Test

- Ensure your `JAVA_HOME` environment is set.
- Clone this repository

```sh
git clone https://github.com/Kentico/kontent-java-packages
git clone https://github.com/kontent-ai/java-packages
```

- Enter the cloned repository

```sh
cd kontent-java-packages
```

- Enter the cloned repository and build the project via the provided Gradle wrapper.
- Copy `local.properties.template` file in this directory to `local.properties` (which will be ignored by Git)

- Set the `sdk.dir` variable Android SDK location

- Build the project via the provided Gradle wrapper.

> To grant execution rights for `gradlew` binary, you could use `chmod a+x ./gradlew` which allows execution to everybody.

```sh
cd kontent-java-packages
./gradlew clean build
```

> The command will build whole solution and run all tests in this monorepo.

#### :bulb: Next steps

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).
The ideal next step is to test out the [Kontent.ai 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.ai Delivery Java SDK](/delivery-sdk#readme).

## Publishing

> 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/).
> 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/).


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.
1. Verify that everything in the branch is ready to be published and
the [build and tests](https://github.com/kontent-ai/java-packages/actions/workflows/gradle.yml) are passing.
1. Create new GitHub release - **the tag name of the release will be used as a version**
* 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.

* 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.
- If you define tag name with "-SNAPSHOT" suffix i.e. `5.0.0-SNAPSHOT` artifact will be published to
the `https://s01.oss.sonatype.org/content/repositories/snapshots/`, so that you could use it when you want to try out
the beta version.

- The creation of a release triggers
the [Publish Github workflow](https://github.com/kontent-ai/java-packages/actions/workflows/publish.yml) and
creates and publishes the artifacts to "Staging" repositories on Nexus repository manager.

1. Log in to the [Nexus Repository Manager](https://oss.sonatype.org/).
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*).
1. Log in to the [Nexus Repository Manager](https://s01.oss.sonatype.org/).
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_).
1. Close the Staging repository
1. Release the Closed repository
1. Increase the patch version and append `-SNAPSHOT` in the bottom of `/build.gradle` file (i.e. `4.4.1-SNAPSHOT`).

> 💡 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).
> 💡 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).
Loading