@clickview/ship-it 0.0.43 → 0.0.45

package/lib/src/utils/Descriptions.js

@@ -2,35 +2,53 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Descriptions = void 0;
 var Headings = {
-    BeforeRelease: 'Before release',
-    Dependencies: 'Dependencies',
-    CodeChanges: 'Code changes',
-    CustomerChanges: 'Customer changes',
+    BeforeRelease: 'Before Release',
+    AfterRelease: 'After Release',
+    Dependencies: 'Deploy Dependencies',
+    CodeChanges: 'Code Changes',
+    CustomerChanges: 'Customer Changes',
     Testing: 'Testing',
-    Notes: 'Notes'
+    Notes: 'Notes',
+    MergeRequestChecklist: 'Merge Request Checklist',
+    Tasks: 'Tasks',
+    SQL: 'SQL',
 };
 var BASE_VALID_HEADINGS = [
     Headings.BeforeRelease,
+    Headings.AfterRelease,
     Headings.Dependencies,
     Headings.Testing,
-    Headings.Notes
+    Headings.Notes,
+    Headings.MergeRequestChecklist
 ];
 var PROJECT_VALID_HEADINGS = BASE_VALID_HEADINGS.concat([
     Headings.CustomerChanges,
     Headings.CodeChanges
 ]);
 var PROJECT_REQUIRED_HEADINGS = [
-    Headings.Testing
+    Headings.Testing,
+    Headings.MergeRequestChecklist
 ];
 var HEADING_ORDER = [
-    Headings.BeforeRelease,
     Headings.Dependencies,
+    Headings.BeforeRelease,
+    Headings.AfterRelease,
     Headings.CustomerChanges,
     Headings.CodeChanges,
     '*',
     Headings.Testing,
     Headings.Notes,
 ];
+var IGNORED_HEADINGS = [Headings.MergeRequestChecklist];
+var SPECIAL_HEADINGS = [
+    Headings.BeforeRelease,
+    Headings.AfterRelease,
+];
+var GROUPED_SUBHEADINGS = [
+    Headings.Tasks,
+    Headings.SQL,
+];
+var MERGE_REQUEST_CHECKLIST = "\n# Merge Request Checklist\n- [ ] QA validation is completed.\n- [ ] All dependencies have been addressed.\n- [ ] All before release tasks have been completed.\n- [ ] All after release tasks are ready to be completed.";
 function headingTransformer(heading) {
     // Fix casing of known headings
     var lowerHeading = heading.toLowerCase();
@@ -143,12 +161,24 @@ exports.Descriptions = {
         // Ensure all the headings are valid
         for (var _i = 0, headings_1 = headings; _i < headings_1.length; _i++) {
             var heading = headings_1[_i];
+            if (IGNORED_HEADINGS.includes(heading))
+                continue;
             if (options.validSections.indexOf(heading) === -1)
                 errors.push("Invalid section: ".concat(heading));
+            if (SPECIAL_HEADINGS.includes(heading)) {
+                var subObj = toObject(parsedDescription[heading].split('\n'), '##');
+                var subHeadings = Object.keys(subObj);
+                for (var _a = 0, subHeadings_1 = subHeadings; _a < subHeadings_1.length; _a++) {
+                    var subHeading = subHeadings_1[_a];
+                    if (!GROUPED_SUBHEADINGS.includes(subHeading)) {
+                        errors.push("Invalid sub-section '".concat(subHeading, "' in '").concat(heading, "'"));
+                    }
+                }
+            }
         }
         // Ensure we have all required headings
-        for (var _a = 0, _b = options.requiredSections; _a < _b.length; _a++) {
-            var requiredSection = _b[_a];
+        for (var _b = 0, _c = options.requiredSections; _b < _c.length; _b++) {
+            var requiredSection = _c[_b];
             if (parsedDescription[requiredSection] === undefined)
                 errors.push("Missing section: ".concat(requiredSection));
         }
@@ -162,9 +192,24 @@ exports.Descriptions = {
         var obj = {};
         var _loop_2 = function (descriptionObj) {
             Object.keys(descriptionObj).forEach(function (key) {
-                if (!obj[key])
-                    obj[key] = '';
-                obj[key] += descriptionObj[key] + '\n';
+                if (!SPECIAL_HEADINGS.includes(key)) {
+                    if (!obj[key])
+                        obj[key] = ''; // Keep as string for regular headings
+                    obj[key] += String(descriptionObj[key]) + '\n';
+                    return;
+                }
+                // For special headings, initialise as an object
+                if (!obj[key] || typeof obj[key] === 'string') {
+                    obj[key] = {};
+                }
+                var subObj = toObject(descriptionObj[key].split('\n'), headingPrefix + '#');
+                Object.keys(subObj).forEach(function (subKey) {
+                    if (!obj[key][subKey])
+                        obj[key][subKey] = '';
+                    obj[key][subKey] += subObj[subKey];
+                    if (GROUPED_SUBHEADINGS.includes(subKey))
+                        obj[key][subKey] += '\n';
+                });
             });
         };
         for (var _i = 0, descriptionObjs_1 = descriptionObjs; _i < descriptionObjs_1.length; _i++) {
@@ -172,15 +217,24 @@ exports.Descriptions = {
             _loop_2(descriptionObj);
         }
         var description = '';
-        var orderedHeadings = orderDescriptionHeadings(Object.keys(obj));
+        var orderedHeadings = orderDescriptionHeadings(Object.keys(obj).filter(function (h) { return !IGNORED_HEADINGS.includes(h); }));
         orderedHeadings.forEach(function (key) {
             if (key === Headings.Notes)
                 return;
             if (!obj[key])
                 return;
             description += '\n' + headingPrefix + ' ' + key + '\n';
-            description += obj[key];
+            if (!SPECIAL_HEADINGS.includes(key)) {
+                description += obj[key];
+                return;
+            }
+            // Process subheadings within "Before Release" and "After Release"
+            Object.keys(obj[key]).forEach(function (subKey) {
+                description += '\n' + headingPrefix + '#' + ' ' + subKey + '\n';
+                description += obj[key][subKey];
+            });
         });
+        description += MERGE_REQUEST_CHECKLIST;
         return description;
     },
     getDescriptionSection: function (heading, mergeRequest) {
@@ -206,10 +260,22 @@ exports.Descriptions = {
                     combinedObj[key] = {};
                 var combinedSubObj = toObject(descriptionObj[key].split('\n'), '##');
                 var orderedHeadings = orderDescriptionHeadings(Object.keys(combinedSubObj));
+                if (!SPECIAL_HEADINGS.includes(key)) {
+                    // Regular headings (not BeforeRelease or AfterRelease)
+                    orderedHeadings.forEach(function (subKey) {
+                        if (!combinedObj[key][subKey]) {
+                            combinedObj[key][subKey] = '';
+                        }
+                        combinedObj[key][subKey] += combinedSubObj[subKey];
+                    });
+                    return;
+                }
                 orderedHeadings.forEach(function (subKey) {
                     if (!combinedObj[key][subKey])
                         combinedObj[key][subKey] = '';
                     combinedObj[key][subKey] += combinedSubObj[subKey];
+                    if (GROUPED_SUBHEADINGS.includes(subKey))
+                        combinedObj[key][subKey] += '\n';
                 });
             });
         };
@@ -218,7 +284,7 @@ exports.Descriptions = {
             var descriptionObj = descriptionObjs_2[_i];
             _loop_3(descriptionObj);
         }
-        var orderedHeadings = orderDescriptionHeadings(Object.keys(combinedObj));
+        var orderedHeadings = orderDescriptionHeadings(Object.keys(combinedObj).filter(function (h) { return !IGNORED_HEADINGS.includes(h); }));
         // Build our description
         var description = '';
         orderedHeadings.forEach(function (key) {
@@ -226,11 +292,11 @@ exports.Descriptions = {
                 return;
             description += '\n# ' + key + '\n';
             Object.keys(combinedObj[key]).forEach(function (subKey) {
-                if (key !== Headings.Dependencies && key !== Headings.Testing)
-                    description += '\n## ' + subKey + '\n';
+                description += '\n## ' + subKey + '\n';
                 description += combinedObj[key][subKey];
             });
         });
+        description += MERGE_REQUEST_CHECKLIST;
         return description;
     },
     getMonorepoDescriptionSection: function (subHeading, mergeRequest) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clickview/ship-it",
-  "version": "0.0.43",
+  "version": "0.0.45",
   "description": "Release Manager",
   "main": "./lib/index.js",
   "bin": {