Update README.md and changelog-builder

michelin · Nov 24, 2024 · b735e6a · b735e6a
1 parent 100a089
commit b735e6a
Show file tree

Hide file tree

Showing 2 changed files with 55 additions and 30 deletions.
diff --git a/README.md b/README.md
@@ -24,40 +24,37 @@ This repository contains the source code of the Suricate application.
 * [Download](#download)
 * [Install](#install)
 * [Configuration](#configuration)
-    * [Default Configuration](#default-configuration)
-    * [Database](#database)
-      * [H2 vs PostgreSQL](#h2-vs-postgresql)
-      * [Initialization with Flyway](#initialization-with-flyway)
-    * [Authentication](#authentication)
-      * [LDAP vs Database](#ldap-vs-database)
-      * [Social Login](#social-login)
-        * [GitHub](#github)
-        * [GitLab](#gitlab)
-        * [Redirection to Front-End](#redirection-to-front-end)
-        * [Name Parsing Strategy](#name-parsing-strategy)
-      * [Personal Access Token](#personal-access-token)
-    * [Widgets](#widgets)
-      * [Encryption](#encryption)
-      * [Repositories](#repositories)
-* [Swagger UI](#swagger-ui)
+  * [Default Configuration](#default-configuration)
+  * [Database](#database)
+    * [H2 vs PostgreSQL](#h2-vs-postgresql)
+    * [Initialization with Flyway](#initialization-with-flyway)
+  * [Authentication](#authentication)
+    * [LDAP vs Database](#ldap-vs-database)
+    * [Social Login](#social-login)
+      * [GitHub](#github)
+      * [GitLab](#gitlab)
+      * [Redirection to Front-End](#redirection-to-front-end)
+      * [Name Parsing Strategy](#name-parsing-strategy)
+    * [Personal Access Token](#personal-access-token)
+  * [Widgets](#widgets)
+    * [Encryption](#encryption)
+    * [Repositories](#repositories)
+* [Swagger](#swagger)
 * [Contribution](#contribution)
 
 ## Download
 
-You can download Suricate as a fat jar from the project's releases page on GitHub
-at https://github.com/michelin/suricate/releases. 
+You can download Suricate as a fat jar from the [GitHub releases page](https://github.com/michelin/suricate/release) (requires Java 21).
 
-Please note that Java 21 is required starting from Suricate 2.8.0 (Java 8 before).
-
-Additionally, a Docker image of the solution is available at https://hub.docker.com/repository/docker/michelin/suricate.
+Additionally, a Docker image is available at https://hub.docker.com/repository/docker/michelin/suricate.
 
 ## Install
 
 Suricate is built on the [Spring Boot framework](https://spring.io/) and can be configured using a Spring Boot
 configuration file, which includes a sample file located at `src/main/resources/application.properties`.
 
 If necessary, you can override the properties from the default `application.properties` file by following
-the [Spring Boot externalized configuration guide](https://docs.spring.io/spring-boot/docs/1.4.1.RELEASE/reference/html/boot-features-external-config.html).
+the [Spring Boot externalized configuration guide](https://docs.spring.io/spring-boot/reference/features/external-config.html).
 For example, you can create a custom  `/config/application.properties` or set the `--spring.config.location` system
 property when running the fat jar file:
 
@@ -310,9 +307,15 @@ login: [ Your GitHub login ]
 password: [ Your GitHub password ]
 ```
 
-## Swagger UI
+### Swagger
+
+Suricate uses [Springdoc](https://springdoc.org/) to generate an API documentation.
+
+By default:
+- The Swagger UI page is available at http://localhost:8080/swagger-ui/index.html.
+- The OpenAPI description is available at http://localhost:8080/v3/api-docs.
 
-Suricate provides a Swagger UI to test the API. You can access it at http://localhost:8080/swagger-ui/index.html.
+Both can be customized by using the [Springdoc properties](https://springdoc.org/#properties).
 
 You can authenticate using the `POST /api/v1/auth/signin` endpoint and then use the `Authorize` button to add the
 JWT token in the `Authorization` header.

diff --git a/changelog-builder.json b/changelog-builder.json
@@ -2,25 +2,47 @@
   "categories": [
     {
       "title": "## :sparkles: New features",
-      "labels": ["feature"]
+      "labels": [
+        "feature"
+      ]
     },
     {
       "title": "## :bug: Bug fixes",
-      "labels": ["bug"]
+      "labels": [
+        "bug"
+      ]
     },
     {
       "title": "## :zap: Improvements",
-      "labels": ["enhancement"]
+      "labels": [
+        "enhancement"
+      ]
     },
     {
       "title": "## :memo: Documentation",
-      "labels": ["documentation"]
+      "labels": [
+        "documentation"
+      ]
     },
     {
       "title": "## :arrow_up: Dependency updates",
-      "labels": ["dependencies"]
+      "labels": [
+        "dependencies"
+      ]
+    },
+    {
+      "title": "## :test_tube: Tests",
+      "labels": [
+        "test"
+      ]
+    },
+    {
+      "title": "## :green_heart: CI/CD",
+      "labels": [
+        "ci/cd"
+      ]
     }
   ],
   "template": "${{CHANGELOG}}\n\n<details>\n<summary>Uncategorized</summary>\n\n${{UNCATEGORIZED}}\n</details>",
   "pr_template": "- ${{TITLE}} by @${{AUTHOR}} in #${{NUMBER}}"
-}
+}