From b9bc68c4e13117b835c311d0241f73af31f2cf84 Mon Sep 17 00:00:00 2001
From: "Matteo Franci a.k.a. Fugerit" <m@fugerit.org>
Date: Sun, 11 Feb 2024 16:02:03 +0100
Subject: [PATCH] workflows review and documentation

---
 .github/workflows/build_maven_compatibility.yml | 14 ++++++--------
 .github/workflows/build_maven_package.yml       |  2 ++
 .github/workflows/codeql-analysis.yml           | 13 +++++++------
 .github/workflows/deploy_maven_package.yml      | 14 ++++++--------
 CHANGELOG.md                                    |  1 +
 5 files changed, 22 insertions(+), 22 deletions(-)

diff --git a/.github/workflows/build_maven_compatibility.yml b/.github/workflows/build_maven_compatibility.yml
index bc94c8866..e8a203025 100644
--- a/.github/workflows/build_maven_compatibility.yml
+++ b/.github/workflows/build_maven_compatibility.yml
@@ -1,10 +1,8 @@
-# This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-maven
-
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
+# CI maven compatibility check
+#
+# version 1.0.0
+#
+# see : https://universe.fugerit.org/src/docs/conventions/workflows/build_maven_compatibility.html
 
 name: CI maven compatibility check
 
@@ -13,7 +11,7 @@ on:
   # a pull request.
   push:
     branches:
-      - develop
+      - branch-compatibility
 
 jobs:
   check-main:
diff --git a/.github/workflows/build_maven_package.yml b/.github/workflows/build_maven_package.yml
index 1551f53a1..cf81278bc 100644
--- a/.github/workflows/build_maven_package.yml
+++ b/.github/workflows/build_maven_package.yml
@@ -1,5 +1,7 @@
 # CI with maven build and scan
 #
+# version 1.0.0
+#
 # see : https://universe.fugerit.org/src/docs/conventions/workflows/build_maven_package.html
 
 name: CI maven build and scan
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
index 4a3b55f43..9e7bb8166 100644
--- a/.github/workflows/codeql-analysis.yml
+++ b/.github/workflows/codeql-analysis.yml
@@ -1,14 +1,15 @@
+# CodeQL
+#
+# version 1.0.0
+#
+# see : https://universe.fugerit.org/src/docs/conventions/workflows/codeql-analysis.html
+
 # For most projects, this workflow file will not need changing; you simply need
 # to commit it to your repository.
 #
 # You may wish to alter this file to override the set of languages analyzed,
 # or to provide custom queries or build logic.
-#
-# ******** NOTE ********
-# We have attempted to detect the languages in your repository. Please check
-# the `language` matrix defined below to confirm you have the correct set of
-# supported CodeQL languages.
-#
+
 name: "CodeQL"
 
 on:
diff --git a/.github/workflows/deploy_maven_package.yml b/.github/workflows/deploy_maven_package.yml
index f99ee066c..a4e039add 100644
--- a/.github/workflows/deploy_maven_package.yml
+++ b/.github/workflows/deploy_maven_package.yml
@@ -1,17 +1,15 @@
-# This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-maven
-
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
+# CI deploy maven package
+#
+# version 1.0.0
+#
+# see : https://universe.fugerit.org/src/docs/conventions/workflows/deploy_maven_package.html
 
 name: CI deploy maven package 
 
 on:
   push:
     branches:
-    - deploy
+    - branch-deploy
 
 jobs:
   build:
diff --git a/CHANGELOG.md b/CHANGELOG.md
index ec23eb702..032d7ecec 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- workflows review and documentation
 - [playground-quarkus] quarkus-version set to 3.7.2
 - [playground-quarkus] base image changed to 21.0.2_13-jre-ubi9-minimal