docs(changelog): Rework CHANGELOG style [skip ci]

Author: julienloizelet

.github/workflows/release.yml

@@ -21,6 +21,8 @@ jobs:
   prepare-release:
     name: Prepare release
     runs-on: ubuntu-latest
+    env:
+      GITHUB_URL: "https://github.com/crowdsecurity/php-cs-bouncer"
 
     steps:
       - name: Check naming convention
@@ -42,24 +44,40 @@ jobs:
       - name: Check version ${{ env.VERSION_NUMBER }} consistency in files
         # Check src/Constants.php and CHANGELOG.md
         run: |
+          : # Check public const VERSION = 'vVERSION_NUMBER'; in CHANGELOG.md in src/Constants.php
+          CONSTANT_VERSION=$(grep -E "public const VERSION = 'v(.*)';"  src/Constants.php | sed 's/ //g')
+          if [[ $CONSTANT_VERSION == "publicconstVERSION='v${{ env.VERSION_NUMBER }}';" ]]
+          then
+          echo "CONSTANT VERSION OK"
+          else
+          echo "CONSTANT VERSION KO"
+          exit 1
+          fi
+          
+          : # Check top ## [VERSION_NUMBER](GITHUB_URL/releases/tag/vVERSION_NUMBER) - yyyy-mm-dd in CHANGELOG.md
           CURRENT_DATE=$(date +'%Y-%m-%d')
           echo $CURRENT_DATE
-          CHANGELOG_VERSION=$(grep -o -E "## \[(.*)\] - $CURRENT_DATE"  CHANGELOG.md | head -1 | sed 's/ //g')
+          CHANGELOG_VERSION=$(grep -o -E "## \[(.*)\].* - $CURRENT_DATE"  CHANGELOG.md | head -1 | sed 's/ //g')
           echo $CHANGELOG_VERSION
-          if [[ $CHANGELOG_VERSION == "##[${{ env.VERSION_NUMBER }}]-$CURRENT_DATE" ]]
+          if [[ $CHANGELOG_VERSION == "##[${{ env.VERSION_NUMBER }}](${{ env.GITHUB_URL }}/releases/tag/v${{ env.VERSION_NUMBER }})-$CURRENT_DATE" ]]
           then
               echo "CHANGELOG VERSION OK"
           else
               echo "CHANGELOG VERSION KO"
               exit 1
           fi
-          CONSTANT_VERSION=$(grep -E "public const VERSION = 'v(.*)';"  src/Constants.php | sed 's/ //g')
-          if [[ $CONSTANT_VERSION == "publicconstVERSION='v${{ env.VERSION_NUMBER }}';" ]]
+          
+          : # Check top [_Compare with previous release_](GITHUB_URL/compare/vLAST_TAG...vVERSION_NUMBER) in CHANGELOG.md
+          COMPARISON=$(grep -oP "\/compare\/\K(.*)$" CHANGELOG.md | head -1)
+          LAST_TAG=$(curl -Ls -o /dev/null -w %{url_effective} ${{ env.GITHUB_URL }}/releases/latest | grep -oP "\/tag\/\K(.*)$")
+          if [[ $COMPARISON == "$LAST_TAG...v${{ env.VERSION_NUMBER }})" ]]
           then
-              echo "CONSTANT VERSION OK"
+            echo "VERSION COMPARISON OK"
           else
-              echo "CONSTANT VERSION KO"
-              exit 1
+            echo "VERSION COMPARISON KO"
+            echo $COMPARISON
+            echo "$LAST_TAG...v${{ env.VERSION_NUMBER }})"
+            exit 1
           fi
 
       - name: Create Tag ${{ github.event.inputs.tag_name }}
@@ -76,10 +94,9 @@ jobs:
 
       - name: Prepare release notes
         run: |
-          VERSION_RELEASE_NOTES=$(awk -v ver="[${{ env.VERSION_NUMBER }}]" '/^## / { if (p) { exit }; if ($2 == ver) { p=1; next} } p && NF' CHANGELOG.md)
+          VERSION_RELEASE_NOTES=$(awk -v ver="[${{ env.VERSION_NUMBER }}](${{ env.GITHUB_URL }}/releases/tag/v${{ env.VERSION_NUMBER }})" '/^## / { if (p) { exit }; if ($2 == ver) { p=1; next} } p && NF' CHANGELOG.md | sed ':a;N;$!ba;s/\n---/ /g')
           echo "$VERSION_RELEASE_NOTES" >> CHANGELOG.txt
 
-
       - name: Create release ${{ env.VERSION_NUMBER }}
         uses: softprops/action-gh-release@v1
         with: