Merge pull request #793 from yinan-symphony/bugfix/readme

Update github actions version and README.md

.github/workflows/build.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
 
     - name: Set up JDK 17
       uses: actions/setup-java@v3

.github/workflows/cve-scanning-gradle.yml

@@ -14,7 +14,7 @@ jobs:
   scan:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up JDK 17
         uses: actions/setup-java@v3
         with:

.github/workflows/docs.yml

@@ -20,17 +20,17 @@ jobs:
         working-directory: docs
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup Ruby
-        uses: ruby/setup-ruby@250fcd6a742febb1123a77a841497ccaa8b9e939
+        uses: ruby/setup-ruby@ec02537da5712d66d4d50a0f33b7eb52773b5ed1
         with:
           ruby-version: '3.1'
           bundler-cache: true
           cache-version: 0
           working-directory: '${{ github.workspace }}/docs'
       - name: Setup Pages
         id: pages
-        uses: actions/configure-pages@v3
+        uses: actions/configure-pages@v4
       - name: Build with Jekyll
         run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
         env:

.github/workflows/gradle-wrapper-validation.yml

@@ -8,5 +8,5 @@ jobs:
     name: "Validation"
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: gradle/wrapper-validation-action@56b90f209b02bf6d1deae490e9ef18b21a389cd4

.github/workflows/release.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Set up JDK 17
         uses: actions/setup-java@v3

.github/workflows/semgrep.yml

@@ -9,7 +9,7 @@ jobs:
     container:
       image: returntocorp/semgrep
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - run: semgrep scan --error --config auto
       env:
         SEMGREP_APP_TOKEN: ${{ secrets.SEMGREP_APP_TOKEN }}

README.md

@@ -5,6 +5,19 @@
 [![javadoc](https://javadoc.io/badge2/org.finos.symphony.bdk/symphony-bdk-core/javadoc.svg)](https://javadoc.io/doc/org.finos.symphony.bdk/symphony-bdk-core)
 
 # Symphony BDK for Java
+
+> [!NOTE]
+> BDK version 3.0: Major change !
+>
+> The newly introduced BDK version 3.0 relies on Java 17 and SpringBoot 3. This is a major change that allows Symphony to continue to propose the latest security fixes following the end of support of Spring Boot 2 and also to keep up with the latest evolutions of Java.
+>
+> For the next 6 months Symphony will provide critical security fixes for BDK 2.0 where possible (since Spring gives no guarantees for their packages).
+>
+> Please consider migrating your Bots in the coming months to benefit from the latest features and support.
+
+> [!IMPORTANT]
+> As detailed above, the BDK version 2.0 will stop being supported by Symphony on August 15.
+
 The **official** Symphony BDK for Java helps you to create production-grade Chat Bots and Extension Applications on 
 top of the [Symphony REST APIs](https://developers.symphony.com/restapi/reference). 
 

docs/index.md

@@ -6,21 +6,18 @@ nav_order: 1
 
 # Symphony BDK Reference Documentation
 
-{% hint style="info" %}
-
-### BDK version 3.0: Major change !
-
- The newly introduced BDK version 3.0 relies on Java 17 and SpringBoot 3. This is a major change that allows Symphony to continue to propose the latest security fixes following the end of support of Spring Boot 2 and also to keep up with the latest evolutions of Java.
-
- For the next 6 months Symphony will provide critical security fixes for BDK 2.0 where possible (since Spring gives no guarantees for their packages).
-
- Please consider migrating your Bots in the coming months to benefit from the latest features and support. 
-
-{% endhint %}
-
-{% hint style="warning" %}
- As detailed above, the BDK version 2.0 will stop being supported by Symphony on August 15.
-{% endhint %}
+>
+> ### BDK version 3.0: Major change !
+> 
+> The newly introduced BDK version 3.0 relies on Java 17 and SpringBoot 3. This is a major change that allows Symphony to continue to propose the latest security fixes following the end of support of Spring Boot 2 and also to keep up with the latest evolutions of Java.
+> 
+> For the next 6 months Symphony will provide critical security fixes for BDK 2.0 where possible (since Spring gives no guarantees for their packages).
+> 
+> Please consider migrating your Bots in the coming months to benefit from the latest features and support. 
+>
+>> ### Note !
+>> As detailed above, the BDK version 2.0 will stop being supported by Symphony on August 15.
+>>
 
 This reference guide provides detailed information about the Symphony BDK. It provides a comprehensive documentation
 for all features and abstractions made on top of the [Symphony REST API](https://developers.symphony.com/restapi/reference/introduction).