chore(gha): test changelog workflow (#27)

* chore(gha): test changelog workflow

* chore(gha): change comment body

* chore(gha): change add changes

* chore(gha): message on success

Author: cesararroba

.github/workflows/pull-request-changelog.yml

@@ -29,26 +29,30 @@ jobs:
         id: check_folders
         run: |
           missing_changelogs=""
-
+      
           for folder in api ui prowler; do
             if grep -q "^${folder}/" changed_files.txt; then
               echo "Detected changes in ${folder}/"
               if ! grep -q "^${folder}/CHANGELOG.md$" changed_files.txt; then
                 echo "No changelog update found for ${folder}/"
-                missing_changelogs="${missing_changelogs}${folder} "
+                missing_changelogs="${missing_changelogs}- \`${folder}\`\n"
               fi
             fi
           done
-
-          echo "missing_changelogs=${missing_changelogs}" >> $GITHUB_OUTPUT
+      
+          echo "missing_changelogs<<EOF" >> $GITHUB_OUTPUT
+          echo -e "${missing_changelogs}" >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
 
       - name: Comment on PR if changelog is missing
-        if: steps.check_folders.outputs.missing_changelogs != ''
-        uses: peter-evans/create-or-update-comment@71345be0265236311c031f5c7866368bd1eff043 # v4.0.0
+        uses: peter-evans/create-or-update-comment@v4
         with:
           issue-number: ${{ github.event.pull_request.number }}
+          body-identifier: changelog-check
           body: |
-            ⚠️ **Changes detected in the following folders that have not been updated in your CHANGELOG.md**:
-            ${{ steps.check_folders.outputs.missing_changelogs }}
-
-            Please add an entry to the corresponding `CHANGELOG.md` to maintain a clear history of changes.
+            ${{ steps.check_folders.outputs.missing_changelogs != '' && format(
+            '⚠️ **Changes detected in the following folders without a corresponding update to the `CHANGELOG.md`:**
+      
+            {0}
+            
+            Please add an entry to the corresponding `CHANGELOG.md` file to maintain a clear history of changes.', steps.check_folders.outputs.missing_changelogs) || '✅ All necessary CHANGELOG.md files have been updated. Great job! 🎉' }}

.gitignore

@@ -0,0 +1,2 @@
+.code
+.idea

api/CHANGELOG.md

@@ -1 +1,3 @@
-API Changelog
+API Changelog
+
+- New file `hello-world.txt`

api/hello-world.txt

@@ -1 +1,3 @@
-Prowler Changelog
+Prowler Changelog
+
+- New file `hello-world.txt`

prowler/CHANGELOG.md

@@ -0,0 +1,3 @@
+UI Changelog
+
+- New file `hello-world.txt`