From 933f8e58ff33cad58261c0e100b17496f3e646f6 Mon Sep 17 00:00:00 2001 From: AnasNaouchi Date: Wed, 11 Sep 2024 04:20:28 +0700 Subject: [PATCH 1/4] Add versioning in readme --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index aab507eb..44bfb55b 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,26 @@ library and the functionality it provides. As of version `v5.0.0`, `joda-time` has been deprecated in favor of java-time so you might see a different format for the string output of date parameters and some functions might not be available anymore. For more reference view this PR([#173](https://github.com/omise/omise-java/pull/173)) +# Versioning and Compatibility + +Although you can use omise-java with other Java versions, we have validated the following versions in our CI pipeline to ensure compatibility and stability. + +### Java Runtime Version(s) Supported + +Represents the java version that needs to be installed on your local in order to be able to run the precompiled java byte code inside your project. i.e Installing the SDK in your project from maven and running it in your custom project. + +### Minimum Java Version Required for Compilation + +Represents the Java version required to compile the SDK after you clone the SDK's repo or fork it. + +| Library Version | Support | Supported Omise API Version | Java Runtime Version(s) Supported | Minimum Java Version Required for Compilation | Compilation Tested On | Notes | +| --------------- | ----------------------- | --------------------------- | --------------------------------- | --------------------------------------------- | --------------------- | -------------------------------------------------------------------------------------- | +| 1.x | End of Life (EOL) | 2014-07-27 | Java 5 >= | Java 7 | N/A | Initial release with basic features. No longer maintained. | +| 2.x | End of Life (EOL) | 2017-11-02 | Java 6 >= | Java 8 | N/A | Ground-up rewrite onto Java7 to be more robust and maintainable. No longer maintained. | +| 3.x | End of Life (EOL) | 2019-05-29 | Java 8 >= | Java 8 | Java 8 | Used latest API version (`2019-05-29`). No longer maintained. | +| 4.x | Long Term Support (LTS) | 2019-05-29 | Java 8 >= | Java 8 | Java 8 | v4 migration. Check [guide][10] | +| 5.x | Active | 2019-05-29 | Java 8 >= | Java 11 | Java 21 | Update gradle to 8.7 and JDK to 21 and replace deprecated joda time. | + ## Installation You can use your preferred method of managing dependencies in order to install the omise-java library. Below you will find some popular examples: @@ -140,3 +160,4 @@ On February 23, 2023, we started redirecting users from search.maven.org to cent [7]: https://github.com/johnrengelman/shadow [8]: https://dashboard.omise.co/test/api-keys [9]: https://github.com/johnrengelman/shadow +[10]: https://github.com/omise/omise-java/blob/master/MIGRATING.md#migrating-from-v3-to-v4 From 6bcf5b8d917443c3959743bee2378d6222bbcbbb Mon Sep 17 00:00:00 2001 From: AnasNaouchi Date: Wed, 11 Sep 2024 05:33:58 +0700 Subject: [PATCH 2/4] set v4 to EOL --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 44bfb55b..7b719385 100644 --- a/README.md +++ b/README.md @@ -26,13 +26,13 @@ Represents the java version that needs to be installed on your local in order to Represents the Java version required to compile the SDK after you clone the SDK's repo or fork it. -| Library Version | Support | Supported Omise API Version | Java Runtime Version(s) Supported | Minimum Java Version Required for Compilation | Compilation Tested On | Notes | -| --------------- | ----------------------- | --------------------------- | --------------------------------- | --------------------------------------------- | --------------------- | -------------------------------------------------------------------------------------- | -| 1.x | End of Life (EOL) | 2014-07-27 | Java 5 >= | Java 7 | N/A | Initial release with basic features. No longer maintained. | -| 2.x | End of Life (EOL) | 2017-11-02 | Java 6 >= | Java 8 | N/A | Ground-up rewrite onto Java7 to be more robust and maintainable. No longer maintained. | -| 3.x | End of Life (EOL) | 2019-05-29 | Java 8 >= | Java 8 | Java 8 | Used latest API version (`2019-05-29`). No longer maintained. | -| 4.x | Long Term Support (LTS) | 2019-05-29 | Java 8 >= | Java 8 | Java 8 | v4 migration. Check [guide][10] | -| 5.x | Active | 2019-05-29 | Java 8 >= | Java 11 | Java 21 | Update gradle to 8.7 and JDK to 21 and replace deprecated joda time. | +| Library Version | Support | Supported Omise API Version | Java Runtime Version(s) Supported | Minimum Java Version Required for Compilation | Compilation Tested On | Notes | +| --------------- | ----------------- | --------------------------- | --------------------------------- | --------------------------------------------- | --------------------- | -------------------------------------------------------------------------------------- | +| 1.x | End of Life (EOL) | 2014-07-27 | Java 5 >= | Java 7 | N/A | Initial release with basic features. No longer maintained. | +| 2.x | End of Life (EOL) | 2017-11-02 | Java 6 >= | Java 8 | N/A | Ground-up rewrite onto Java7 to be more robust and maintainable. No longer maintained. | +| 3.x | End of Life (EOL) | 2019-05-29 | Java 8 >= | Java 8 | Java 8 | Used latest API version (`2019-05-29`). No longer maintained. | +| 4.x | End of Life (EOL) | 2019-05-29 | Java 8 >= | Java 8 | Java 8 | v4 migration. Check [guide][10] | +| 5.x | Active | 2019-05-29 | Java 8 >= | Java 11 | Java 21 | Update gradle to 8.7 and JDK to 21 and replace deprecated joda time. | ## Installation From 0bfbc61bacd3003086ece36c04425dbf8cd4457b Mon Sep 17 00:00:00 2001 From: AnasNaouchi Date: Fri, 13 Sep 2024 04:51:52 +0700 Subject: [PATCH 3/4] Update table --- README.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 7b719385..b2e880cc 100644 --- a/README.md +++ b/README.md @@ -18,21 +18,23 @@ As of version `v5.0.0`, `joda-time` has been deprecated in favor of java-time so Although you can use omise-java with other Java versions, we have validated the following versions in our CI pipeline to ensure compatibility and stability. -### Java Runtime Version(s) Supported +### JRE Supported Represents the java version that needs to be installed on your local in order to be able to run the precompiled java byte code inside your project. i.e Installing the SDK in your project from maven and running it in your custom project. -### Minimum Java Version Required for Compilation +### Java Version (Compilation) Represents the Java version required to compile the SDK after you clone the SDK's repo or fork it. -| Library Version | Support | Supported Omise API Version | Java Runtime Version(s) Supported | Minimum Java Version Required for Compilation | Compilation Tested On | Notes | -| --------------- | ----------------- | --------------------------- | --------------------------------- | --------------------------------------------- | --------------------- | -------------------------------------------------------------------------------------- | -| 1.x | End of Life (EOL) | 2014-07-27 | Java 5 >= | Java 7 | N/A | Initial release with basic features. No longer maintained. | -| 2.x | End of Life (EOL) | 2017-11-02 | Java 6 >= | Java 8 | N/A | Ground-up rewrite onto Java7 to be more robust and maintainable. No longer maintained. | -| 3.x | End of Life (EOL) | 2019-05-29 | Java 8 >= | Java 8 | Java 8 | Used latest API version (`2019-05-29`). No longer maintained. | -| 4.x | End of Life (EOL) | 2019-05-29 | Java 8 >= | Java 8 | Java 8 | v4 migration. Check [guide][10] | -| 5.x | Active | 2019-05-29 | Java 8 >= | Java 11 | Java 21 | Update gradle to 8.7 and JDK to 21 and replace deprecated joda time. | +| Library Version | Support | Supported Omise API Version | JRE Supported | Java Version (Compilation) | Compilation Tested | Notes | +| --------------- | ----------------- | --------------------------- | ------------- | -------------------------- | ------------------ | -------------------------------------------------------------------------------------- | +| 1.x | End of Life (EOL) | 2014-07-27 | >= 5 | >= 7 | N/A | Initial release with basic features. No longer maintained. | +| 2.x | End of Life (EOL) | 2017-11-02 | >= 6 | >= 8 | N/A | Ground-up rewrite onto Java7 to be more robust and maintainable. No longer maintained. | +| 3.x | End of Life (EOL) | 2019-05-29 | >= 8 | >= 8 | Java 8 | Used latest API version (`2019-05-29`). No longer maintained. | +| 4.x | Maintenance Mode | 2019-05-29 | >= 8 | >= 8 | Java 8 | v4 migration. Check [guide][10] | +| 5.x | Active | 2019-05-29 | >= 8 | >= 11 | Java 21 | Update gradle to 8.7 and JDK to 21 and replace deprecated joda time. | + +\*Maintenance mode includes only bug fixes and security updates. ## Installation From cacdf3181a80f11070ea3d020d792c5b2c66cc22 Mon Sep 17 00:00:00 2001 From: AnasNaouchi Date: Mon, 16 Sep 2024 12:59:38 +0700 Subject: [PATCH 4/4] Update JRE description --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b2e880cc..2a381084 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ Although you can use omise-java with other Java versions, we have validated the ### JRE Supported -Represents the java version that needs to be installed on your local in order to be able to run the precompiled java byte code inside your project. i.e Installing the SDK in your project from maven and running it in your custom project. +Represents the Java version you must install on your local system to run the precompiled Java byte code inside your project. i.e., install the SDK from Maven for your project and run it on your custom project. ### Java Version (Compilation)