[gh] Furhter Impove Changelog Workflow (#2655)

* Impove Workflow

* Impove Workflow

.github/autolabeler-config.json

@@ -1,17 +1,5 @@
 
 {
-  "breaking change": [
-    {
-      "fileStatus": "renamed",
-      "includeGlobs": ["ct/**", "install/**", "misc/**", "turnkey/**", "vm/**"],
-      "excludeGlobs": []
-    },
-    {
-      "fileStatus": "removed", 
-      "includeGlobs": ["ct/**", "install/**", "misc/**", "turnkey/**", "vm/**"],
-      "excludeGlobs": []
-    }
-  ],
   "new script": [
     {
       "fileStatus": "added",
@@ -33,10 +21,17 @@
       "excludeGlobs": []
     }
   ],
-  "rename script": [
+  "maintenance": [
     {
-      "fileStatus": "renamed", 
+      "fileStatus": null,
-      "includeGlobs": ["ct/**", "install/**", "misc/**", "turnkey/**", "vm/**"],
+      "includeGlobs": ["*.md", ".github/**", "misc/*.func", "ct/create_lxc.sh", "api/**"],
+      "excludeGlobs": []
+    }
+  ],
+  "core": [
+    {
+      "fileStatus": null,
+      "includeGlobs": ["misc/*.func", "ct/create_lxc.sh"],
       "excludeGlobs": []
     }
   ],
@@ -47,20 +42,28 @@
       "excludeGlobs": []
     }
   ],
-  "maintenance": [
+  "api": [
-    {
-      "fileStatus": null,
-      "includeGlobs": ["*.md", ".github/**", "misc/*.func", "ct/create_lxc.sh"],
-      "excludeGlobs": ["misc/api.func"]
-    }
-  ],
-   "api": [
     {
       "fileStatus": null,
       "includeGlobs": ["api/**", "misc/api.func"],
       "excludeGlobs": []
     }
   ],
+  "github": [
+    {
+      "fileStatus": null,
+      "includeGlobs": [".github/**"],
+      "excludeGlobs": []
+    }
+  ],
+  "json": [
+    {
+      "fileStatus": "modified",
+      "includeGlobs": ["json/**"],
+      "excludeGlobs": []
+    }
+  ],
+
   "high risk": [
     {
       "fileStatus": null,
@@ -68,4 +71,6 @@
       "excludeGlobs": []
     }
   ]
+  
+  
 }

.github/changelog-pr-config.json

@@ -1,16 +1,8 @@
 [
-  {
-    "title": "💥 Breaking Changes",
-    "labels": ["breaking change"]
-  },
   {
     "title": "🆕 New Scripts",
     "labels": ["new script"]
   },
-  {
-    "title": "✨ New Features",
-    "labels": ["feature"]
-  },
   {
     "title": "🚀 Updated Scripts",
     "labels": ["update script"],
@@ -21,27 +13,85 @@
         "notes" : []
       },
       {
-        "title": "General Updates",
+        "title": "✨ New Features",
-        "labels": ["general"],
+        "labels": ["feature"],
+        "notes" : []
+      },
+      {
+        "title": "💥 Breaking Changes",
+        "labels": ["breaking change"],
         "notes" : []
       }
     ]
   },
-  
-  {
-    "title": "🌐 Website",
-    "labels": ["website"]
-  },
-  {
-    "title": "📡 API",
-    "labels": ["api"]
-  },
   {
     "title": "🧰 Maintenance",
-    "labels": ["maintenance"]
+    "labels": ["maintenance"],
+    "subCategories": [
+      {
+        "title": "🐞 Bug Fixes",
+        "labels": ["bugfix"],
+        "notes" : []
+      },
+      {
+        "title": "✨ New Features",
+        "labels": ["feature"],
+        "notes" : []
+      },
+      {
+        "title": "💥 Breaking Changes",
+        "labels": ["breaking change"],
+        "notes" : []
+      },
+      {
+        "title": "📡 API",
+        "labels": ["api"],
+        "notes" : []
+      },
+      {
+        "title": "💾 Core",
+        "labels": ["core"],
+        "notes" : []
+      },
+      {
+        "title": "📂 Github",
+        "labels": ["github"],
+        "notes" : []
+      }
+    ]
+  },
+  {
+    "title": "🌐 Website",
+    "labels": ["website"],
+    "subCategories": [
+      {
+        "title": "🐞 Bug Fixes",
+        "labels": ["bugfix"],
+        "notes" : []
+      },
+      {
+        "title": "✨ New Features",
+        "labels": ["feature"],
+        "notes" : []
+      },
+      {
+        "title": "💥 Breaking Changes",
+        "labels": ["breaking change"],
+        "notes" : []
+      },
+      {
+        "title": "📝 Script Information",
+        "labels": ["json"],
+        "notes" : []
+      }
+    ]
   },
   {
     "title": "❔ Unlabelled",
     "labels": []
+  },
+  {
+    "title": "💥 Breaking Changes",
+    "labels": ["breaking change"]
   }
 ]

.github/pull_request_template.md

@@ -1,25 +1,25 @@
 ## ✍️ Description  
 <!-- Provide a clear and concise description of your changes. -->  
 
-
 ## 🔗 Related PR / Discussion / Issue  
+
 Link: #
 
-
-
 ## ✅ Prerequisites  
+
 Before this PR can be reviewed, the following must be completed:  
+
 - [] **Self-review performed** – Code follows established patterns and conventions.  
 - [] **Testing performed** – Changes have been thoroughly tested and verified.  
 
-
 ## 🛠️ Type of Change  
-Select all that apply:  
-- [] 🐞 **Bug fix** – Resolves an issue without breaking functionality.  
-- [] ✨ **New feature** – Adds new, non-breaking functionality.  
-- [] 💥 **Breaking change** – Alters existing functionality in a way that may require updates.  
-- [] 🆕 **New script** – A fully functional and tested script or script set.  
 
+Select all that apply:
+
+- [] 🆕 **New script** – A fully functional and tested script or script set.
+- [] 🐞 **Bug fix**  – Resolves an issue without breaking functionality.  
+- [] ✨ **New feature**  – Adds new, non-breaking functionality.  
+- [] 💥 **Breaking change**  – Alters existing functionality in a way that may require updates.  
 
 ## 📋 Additional Information (optional)  
 <!-- Provide extra context, screenshots, or references if needed. -->  

.github/workflows/autolabeler.yml

@@ -11,7 +11,7 @@ jobs:
     permissions:
       pull-requests: write
     env:
-      CONFIG_PATH: .github/autolabeler-config.json
+      CONFIG_PATH: .github/autolabeler-config_new.json
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -43,25 +43,7 @@ jobs:
             });
             const prFiles = prListFilesResponse.data;
            
-            const templateLabelMappings = {
-              "🐞 **bug fix**": "bugfix",
-              "✨ **new feature**": "feature",
-              "💥 **breaking change**": "breaking change",
-              "🆕 **new script**": "new script"
-            };
 
-            for (const [checkbox, label] of Object.entries(templateLabelMappings)) {
-              const escapedCheckbox = checkbox.replace(/([.*+?^=!:${}()|\[\]\/\\])/g, "\\$1");
-              const regex = new RegExp(`- \\[(x|X)\\]\\s*.*${escapedCheckbox}`, "i");
-              const match = prBody.match(regex);              
-              if (match) {
-                console.log(`Match: ${match}`);
-                labelsToAdd.add(label);
-              }
-            }
-            if (labelsToAdd.size === 0) {
-              labelsToAdd.add("general");
-            } 
           
             // Apply labels based on file changes
             for (const [label, rules] of Object.entries(autolabelerConfig)) {
@@ -79,6 +61,21 @@ jobs:
                 labelsToAdd.add(label);
               }
             }
+            const templateLabelMappings = {
+              "🐞 **Bug fix**": "bugfix",
+              "✨ **New feature**": "feature",
+              "💥 **Breaking change**": "breaking change",
+            };
+            
+            for (const [checkbox, label] of Object.entries(templateLabelMappings)) {
+              const escapedCheckbox = checkbox.replace(/([.*+?^=!:${}()|\[\]\/\\])/g, "\\$1");
+              const regex = new RegExp(`- \\[(x|X)\\]\\s*.*${escapedCheckbox}`, "i");
+              const match = prBody.match(regex);              
+              if (match) {
+                console.log(`Match: ${match}`);
+                labelsToAdd.add(label);
+              }
+            }
             
             console.log(`Labels to add: ${Array.from(labelsToAdd).join(", ")}`);
 

.github/workflows/changelog-pr.yml

@@ -58,10 +58,26 @@ jobs:
             const categorizedPRs = changelogConfig.map(obj => ({
               ...obj,
               notes: [],
-              subCategories: obj.subCategories ?? (obj.labels.includes("update script") ? [
+              subCategories: obj.subCategories ?? (
-                { title: "🐞 Bug Fixes", labels: ["bugfix"] },
+                obj.labels.includes("update script") ? [
-                { title: "✨ Feature Updates", labels: ["feature"] }
+                  { title: "🐞 Bug Fixes", labels: ["bugfix"], notes: [] },
-              ] : [])
+                  { title: "✨ New Features", labels: ["feature"], notes: [] },
+                  { title: "💥 Breaking Changes", labels: ["breaking change"], notes: [] }
+                ] :
+                obj.labels.includes("maintenance") ? [
+                  { title: "🐞 Bug Fixes", labels: ["bugfix"], notes: [] },
+                  { title: "✨ New Features", labels: ["feature"], notes: [] },
+                  { title: "💥 Breaking Changes", labels: ["breaking change"], notes: [] },
+                  { title: "📡 API", labels: ["api"], notes: [] },
+                  { title: "Github", labels: ["github"], notes: [] }
+                ] :
+                obj.labels.includes("website") ? [
+                  { title: "🐞 Bug Fixes", labels: ["bugfix"], notes: [] },
+                  { title: "✨ New Features", labels: ["feature"], notes: [] },
+                  { title: "💥 Breaking Changes", labels: ["breaking change"], notes: [] },
+                  { title: "Script Information", labels: ["json"], notes: [] }
+                ] : []
+              )
             }));
 
             const latestDateInChangelog = new Date(process.env.LATEST_DATE);
@@ -110,6 +126,7 @@ jobs:
 
             return categorizedPRs;
 
+
       - name: Update CHANGELOG.md
         uses: actions/github-script@v7
         with:
@@ -124,7 +141,8 @@ jobs:
 
             console.log(JSON.stringify(categorizedPRs, null, 2));
 
-            let newReleaseNotes = `## ${today}\n\n### Changes\n\n`;
+
+            let newReleaseNotes = `## ${today}\n\n`;
             for (const { title, notes, subCategories } of categorizedPRs) {
               const hasSubcategories = subCategories && subCategories.length > 0;
               const hasMainNotes = notes.length > 0;
@@ -136,14 +154,13 @@ jobs:
               }
             
               if (hasMainNotes) {
-                newReleaseNotes += `${notes.join("\n")}\n\n`;
+                newReleaseNotes += `  ${notes.join("\n")}\n\n`;
               }
-             
               if (hasSubcategories) {
                 for (const { title: subTitle, notes: subNotes } of subCategories) {
                   if (subNotes && subNotes.length > 0) {
-                    newReleaseNotes += `  #### ${subTitle}\n\n`; 
+                    newReleaseNotes += `  - #### ${subTitle}\n\n`; 
-                    newReleaseNotes += `  ${subNotes.join("\n    ")}\n\n`; 
+                    newReleaseNotes += `    ${subNotes.join("\n    ")}\n\n`; 
                   }
                 }
               }