@clickview/ship-it 0.0.10 → 0.0.12

package/lib/src/commands/CreateTestingNotesCommand.js

@@ -0,0 +1,84 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateTestingNotesCommand = void 0;
+require("reflect-metadata");
+var inversify_1 = require("inversify");
+var types_1 = require("../types");
+var CreateTestingNotesCommand = /** @class */ (function () {
+    function CreateTestingNotesCommand(validateDescriptionsTask, createTestingNotesTask) {
+        this.validateDescriptionsTask = validateDescriptionsTask;
+        this.createTestingNotesTask = createTestingNotesTask;
+    }
+    CreateTestingNotesCommand.prototype.run = function (options) {
+        return __awaiter(this, void 0, void 0, function () {
+            var cont;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.validateDescriptionsTask.run(options)];
+                    case 1:
+                        cont = _a.sent();
+                        if (!cont)
+                            return [2 /*return*/, false];
+                        return [4 /*yield*/, this.createTestingNotesTask.run(options)];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    CreateTestingNotesCommand = __decorate([
+        (0, inversify_1.injectable)(),
+        __param(0, (0, inversify_1.inject)(types_1.TASKS.ValidateDescriptionsTask)),
+        __param(1, (0, inversify_1.inject)(types_1.TASKS.CreateTestingNotesTask)),
+        __metadata("design:paramtypes", [Object, Object])
+    ], CreateTestingNotesCommand);
+    return CreateTestingNotesCommand;
+}());
+exports.CreateTestingNotesCommand = CreateTestingNotesCommand;

package/lib/src/commands/index.js

@@ -19,6 +19,7 @@ __exportStar(require("./CreateBranchCommand"), exports);
 __exportStar(require("./CreateMergeRequestCommand"), exports);
 __exportStar(require("./ListProjectsCommand"), exports);
 __exportStar(require("./CreateReleaseNotesCommand"), exports);
+__exportStar(require("./CreateTestingNotesCommand"), exports);
 __exportStar(require("./InstallPackagesCommand"), exports);
 __exportStar(require("./ReleaseCommand"), exports);
 __exportStar(require("./StartConsumingProjectBuildsCommand"), exports);

package/lib/src/constants/CommandTypeMapping.js

@@ -9,6 +9,7 @@ exports.CommandTypeMapping = {
     'create-branches': types_1.COMMANDS.CreateBranchCommand,
     'create-mrs': types_1.COMMANDS.CreateMergeRequestCommand,
     'create-notes': types_1.COMMANDS.CreateReleaseNotesCommand,
+    'create-testing-notes': types_1.COMMANDS.CreateTestingNotesCommand,
     'install-packages': types_1.COMMANDS.InstallPackagesCommand,
     'bump-packages': types_1.COMMANDS.BumpPackagesCommand,
     'validate-mr': types_1.COMMANDS.ValidateMergeRequestCommand,

package/lib/src/interfaces/models/ProjectConfig.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefaultProjectConfig = void 0;
+exports.DefaultProjectConfig = {
+    monorepo: {
+        enabled: false,
+        validSubProjects: []
+    }
+};

package/lib/src/inversify.config.js

@@ -35,6 +35,7 @@ function createContainer(config) {
     container.bind(types_1.TASKS.CreateMergeRequestTask).to(tasks_1.CreateMergeRequestTask);
     container.bind(types_1.TASKS.ValidateDescriptionsTask).to(tasks_1.ValidateDescriptionsTask);
     container.bind(types_1.TASKS.CreateReleaseNotesTask).to(tasks_1.CreateReleaseNotesTask);
+    container.bind(types_1.TASKS.CreateTestingNotesTask).to(tasks_1.CreateTestingNotesTask);
     container.bind(types_1.TASKS.InstallPackagesTask).to(tasks_1.InstallPackagesTask);
     container.bind(types_1.TASKS.BumpPackagesTask).to(tasks_1.BumpPackagesTask);
     container.bind(types_1.TASKS.CommitPackageVersionsTask).to(tasks_1.CommitPackageVersionsTask);
@@ -53,6 +54,7 @@ function createContainer(config) {
     container.bind(types_1.COMMANDS.CreateMergeRequestCommand).to(commands_1.CreateMergeRequestCommand);
     container.bind(types_1.COMMANDS.ReleaseCommand).to(commands_1.ReleaseCommand);
     container.bind(types_1.COMMANDS.CreateReleaseNotesCommand).to(commands_1.CreateReleaseNotesCommand);
+    container.bind(types_1.COMMANDS.CreateTestingNotesCommand).to(commands_1.CreateTestingNotesCommand);
     container.bind(types_1.COMMANDS.InstallPackagesCommand).to(commands_1.InstallPackagesCommand);
     container.bind(types_1.COMMANDS.BumpPackagesCommand).to(commands_1.BumpPackagesCommand);
     container.bind(types_1.COMMANDS.ValidateMergeRequestCommand).to(commands_1.ValidateMergeRequestCommand);

package/lib/src/services/GitLabService.js

@@ -71,6 +71,7 @@ var types_1 = require("../types");
 var api_clients_1 = require("../api-clients");
 var errors_1 = require("../errors");
 var utils_1 = require("../utils");
+var ProjectConfig_1 = require("../interfaces/models/ProjectConfig");
 /**
  * These are projects that will try to use tags to pull in extra projects
  */
@@ -79,6 +80,7 @@ var MONOREPO_IDS = [
 ];
 var GitLabService = /** @class */ (function () {
     function GitLabService(apiClient) {
+        this.projectConfigCache = {};
         this.apiClient = apiClient;
     }
     GitLabService.prototype.getProjects = function (options) {
@@ -473,6 +475,37 @@ var GitLabService = /** @class */ (function () {
             });
         });
     };
+    GitLabService.prototype.getProjectConfig = function (projectId, branchName) {
+        return __awaiter(this, void 0, void 0, function () {
+            var cacheKey, configFileName, configFile, buff, text, json, projectConfig;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        cacheKey = projectId + ':' + branchName;
+                        if (this.projectConfigCache[cacheKey])
+                            return [2 /*return*/, this.projectConfigCache[cacheKey]];
+                        configFileName = '.ship-it.config';
+                        return [4 /*yield*/, this.apiClient.getFile(projectId, configFileName, branchName)];
+                    case 1:
+                        configFile = _a.sent();
+                        if (!configFile)
+                            return [2 /*return*/, ProjectConfig_1.DefaultProjectConfig];
+                        try {
+                            buff = Buffer.from(configFile.content, 'base64');
+                            text = buff.toString('utf-8');
+                            json = JSON.parse(text);
+                            projectConfig = lodash_1.default.merge({}, ProjectConfig_1.DefaultProjectConfig, json);
+                            this.projectConfigCache[cacheKey] = projectConfig;
+                            return [2 /*return*/, projectConfig];
+                        }
+                        catch (_b) {
+                            throw new errors_1.ShipItError("Failed to parse ".concat(configFileName));
+                        }
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
     GitLabService = __decorate([
         (0, inversify_1.injectable)(),
         __param(0, (0, inversify_1.inject)(types_1.API_CLIENTS.GitLabApiClient)),

package/lib/src/startup/SetupCommands.js

@@ -49,6 +49,7 @@ function setupCommands(program, container) {
     addMilestoneCommand('create-branches', 'Create release branches for all projects that are part of a milestone');
     addMilestoneCommand('create-mrs', 'Create merge requests for all projects that are part of a milestone');
     addMilestoneCommand('create-notes', 'Builds descriptions for all projects that are part of a milestone');
+    addMilestoneCommand('create-testing-notes', 'Builds testing notes for all projects that are part of a milestone');
     addMilestoneCommand('tag-master', 'Tags master for all release MRs that are part of a milestone');
     program.command('release')
         .description('Create releases for all projects that are part of a milestone')

package/lib/src/tasks/CreateMergeRequestTask.js

@@ -60,7 +60,7 @@ var CreateMergeRequestTask = /** @class */ (function () {
     }
     CreateMergeRequestTask.prototype.run = function (options) {
         return __awaiter(this, void 0, void 0, function () {
-            var projects, _i, projects_1, project, _a, branch, branchName, mergeRequest, description;
+            var projects, _i, projects_1, project, _a, branch, branchName, mergeRequest, projectConfig, description;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
@@ -71,14 +71,14 @@ var CreateMergeRequestTask = /** @class */ (function () {
                         _i = 0, projects_1 = projects;
                         _b.label = 2;
                     case 2:
-                        if (!(_i < projects_1.length)) return [3 /*break*/, 7];
+                        if (!(_i < projects_1.length)) return [3 /*break*/, 8];
                         project = projects_1[_i];
                         return [4 /*yield*/, this.service.getNextBranchInfo(project.id, options.version)];
                     case 3:
                         _a = _b.sent(), branch = _a.branch, branchName = _a.branchName;
                         if (!branch) {
                             utils_1.Logger.logError("[".concat(project.title, "]: [").concat(branchName, "] does not exist"));
-                            return [3 /*break*/, 6];
+                            return [3 /*break*/, 7];
                         }
                         return [4 /*yield*/, this.service.getMergeRequest(project.id, branchName, 'opened')];
                     case 4:
@@ -86,21 +86,24 @@ var CreateMergeRequestTask = /** @class */ (function () {
                         if (mergeRequest) {
                             utils_1.Logger.logWarning("[".concat(project.title, "]: MR already exists"));
                             utils_1.Logger.logInfo(mergeRequest.url);
-                            return [3 /*break*/, 6];
+                            return [3 /*break*/, 7];
                         }
-                        description = project.id.toString() === utils_1.ProjectIds.MONOREPO_PROJECT_ID ?
+                        return [4 /*yield*/, this.service.getProjectConfig(project.id, 'dev')];
+                    case 5:
+                        projectConfig = _b.sent();
+                        description = projectConfig.monorepo.enabled ?
                             utils_1.Descriptions.getMonorepoCombinedDescription(project.mergeRequests) :
                             utils_1.Descriptions.getCombinedDescription(project.mergeRequests);
                         return [4 /*yield*/, this.service.createMergeRequest(project.id, branchName, description, options.milestone)];
-                    case 5:
+                    case 6:
                         mergeRequest = _b.sent();
                         utils_1.Logger.logMessage("[".concat(project.title, "]: MR created"));
                         utils_1.Logger.logInfo(mergeRequest.url);
-                        _b.label = 6;
-                    case 6:
+                        _b.label = 7;
+                    case 7:
                         _i++;
                         return [3 /*break*/, 2];
-                    case 7: return [2 /*return*/, true];
+                    case 8: return [2 /*return*/, true];
                 }
             });
         });

package/lib/src/tasks/CreateReleaseNotesTask.js

@@ -65,7 +65,7 @@ var CreateReleaseNotesTask = /** @class */ (function () {
     }
     CreateReleaseNotesTask.prototype.run = function (options) {
         return __awaiter(this, void 0, void 0, function () {
-            var projects, combinedDescription, _i, projects_1, project, fileName, description, outputPath_1, outputPath;
+            var projects, combinedDescription, _i, projects_1, project, fileName, description, projectConfig, outputPath_1, outputPath;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -77,11 +77,14 @@ var CreateReleaseNotesTask = /** @class */ (function () {
                         _i = 0, projects_1 = projects;
                         _a.label = 2;
                     case 2:
-                        if (!(_i < projects_1.length)) return [3 /*break*/, 5];
+                        if (!(_i < projects_1.length)) return [3 /*break*/, 6];
                         project = projects_1[_i];
                         fileName = "".concat(project.title, ".md");
                         description = '';
-                        if (project.id.toString() === utils_1.ProjectIds.MONOREPO_PROJECT_ID) {
+                        return [4 /*yield*/, this.service.getProjectConfig(project.id, 'dev')];
+                    case 3:
+                        projectConfig = _a.sent();
+                        if (projectConfig.monorepo.enabled) {
                             description = utils_1.Descriptions.getMonorepoCombinedDescription(project.mergeRequests);
                         }
                         else {
@@ -91,16 +94,16 @@ var CreateReleaseNotesTask = /** @class */ (function () {
                         combinedDescription += utils_1.Descriptions.bumpHeadings(description);
                         outputPath_1 = "./dist/".concat(options.milestone, "/").concat(fileName);
                         return [4 /*yield*/, fs_extra_1.default.outputFile(path_1.default.resolve(outputPath_1), description)];
-                    case 3:
-                        _a.sent();
-                        _a.label = 4;
                     case 4:
+                        _a.sent();
+                        _a.label = 5;
+                    case 5:
                         _i++;
                         return [3 /*break*/, 2];
-                    case 5:
+                    case 6:
                         outputPath = "./dist/".concat(options.milestone, "/Release Notes.md");
                         return [4 /*yield*/, fs_extra_1.default.outputFile(path_1.default.resolve(outputPath), combinedDescription)];
-                    case 6:
+                    case 7:
                         _a.sent();
                         utils_1.Logger.logMessage('Created file');
                         utils_1.Logger.logInfo("".concat(path_1.default.resolve(outputPath), "\n"));

package/lib/src/tasks/CreateTestingNotesTask.js

@@ -0,0 +1,135 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateTestingNotesTask = void 0;
+require("reflect-metadata");
+var inversify_1 = require("inversify");
+var path_1 = __importDefault(require("path"));
+var fs_extra_1 = __importDefault(require("fs-extra"));
+var types_1 = require("../types");
+var services_1 = require("../services");
+var utils_1 = require("../utils");
+var Csv_1 = require("../utils/Csv");
+var CreateTestingNotesTask = /** @class */ (function () {
+    function CreateTestingNotesTask(service) {
+        this.service = service;
+    }
+    CreateTestingNotesTask.prototype.run = function (options) {
+        return __awaiter(this, void 0, void 0, function () {
+            var projects, projectTestingNotes, _i, projects_1, project, description, _a, _b, mr, outputPath, error_1, csv;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        utils_1.Logger.logTask('Creating testing notes');
+                        return [4 /*yield*/, this.service.getProjects(options)];
+                    case 1:
+                        projects = _c.sent();
+                        projectTestingNotes = [];
+                        for (_i = 0, projects_1 = projects; _i < projects_1.length; _i++) {
+                            project = projects_1[_i];
+                            description = '';
+                            for (_a = 0, _b = project.mergeRequests; _a < _b.length; _a++) {
+                                mr = _b[_a];
+                                if (project.id.toString() === utils_1.ProjectIds.MONOREPO_PROJECT_ID) {
+                                    description = utils_1.Descriptions.getMonorepoCombinedDescription([mr]);
+                                }
+                                else {
+                                    description = utils_1.Descriptions.getCombinedDescription([mr]);
+                                }
+                                projectTestingNotes.push({
+                                    projectName: project.title,
+                                    mrTitle: mr.title,
+                                    mrAuthor: mr.author,
+                                    mrAssignee: mr.assignee,
+                                    mrUrl: mr.url,
+                                    notes: utils_1.Descriptions.bumpHeadings(description).trim()
+                                });
+                            }
+                        }
+                        outputPath = path_1.default.resolve("./dist/".concat(options.milestone));
+                        _c.label = 2;
+                    case 2:
+                        _c.trys.push([2, 4, , 6]);
+                        return [4 /*yield*/, fs_extra_1.default.access(outputPath)];
+                    case 3:
+                        _c.sent();
+                        return [3 /*break*/, 6];
+                    case 4:
+                        error_1 = _c.sent();
+                        return [4 /*yield*/, fs_extra_1.default.ensureDir(outputPath)];
+                    case 5:
+                        _c.sent();
+                        return [3 /*break*/, 6];
+                    case 6:
+                        csv = new Csv_1.CsvFile({
+                            headers: ['projectName', 'mrTitle', 'mrAuthor', 'mrAssignee', 'mrUrl', 'notes'],
+                            path: path_1.default.resolve(outputPath, "".concat(options.milestone, " Testing Notes.csv")),
+                        });
+                        return [4 /*yield*/, csv.create(projectTestingNotes)];
+                    case 7:
+                        _c.sent();
+                        utils_1.Logger.logMessage('Created file');
+                        utils_1.Logger.logInfo("".concat(path_1.default.resolve(outputPath), "\n"));
+                        return [2 /*return*/, true];
+                }
+            });
+        });
+    };
+    CreateTestingNotesTask = __decorate([
+        (0, inversify_1.injectable)(),
+        __param(0, (0, inversify_1.inject)(types_1.SERVICES.GitLabService)),
+        __metadata("design:paramtypes", [services_1.GitLabService])
+    ], CreateTestingNotesTask);
+    return CreateTestingNotesTask;
+}());
+exports.CreateTestingNotesTask = CreateTestingNotesTask;

package/lib/src/tasks/ValidateDescriptionsTask.js

@@ -65,45 +65,75 @@ var ValidateDescriptionsTask = /** @class */ (function () {
     ValidateDescriptionsTask.prototype.run = function (options) {
         var _a;
         return __awaiter(this, void 0, void 0, function () {
-            var projects, cont, _i, projects_1, project, invalidMrs, mergeRequestsTargetingDev, _b, mergeRequestsTargetingDev_1, mr, isMonorepo, isMrValid, groupedByUser, key, _c, _d, mr;
-            return __generator(this, function (_e) {
-                switch (_e.label) {
+            var projects, cont, _loop_1, this_1, _i, projects_1, project;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
                     case 0:
                         utils_1.Logger.logTask('Validating descriptions');
                         return [4 /*yield*/, this.service.getProjects(options)];
                     case 1:
-                        projects = _e.sent();
+                        projects = _b.sent();
                         cont = true;
-                        for (_i = 0, projects_1 = projects; _i < projects_1.length; _i++) {
-                            project = projects_1[_i];
-                            invalidMrs = [];
-                            mergeRequestsTargetingDev = project.mergeRequests.filter(function (mergeRequest) {
-                                return mergeRequest.targetBranch === 'dev';
-                            });
-                            for (_b = 0, mergeRequestsTargetingDev_1 = mergeRequestsTargetingDev; _b < mergeRequestsTargetingDev_1.length; _b++) {
-                                mr = mergeRequestsTargetingDev_1[_b];
-                                isMonorepo = project.id.toString() === utils_1.ProjectIds.MONOREPO_PROJECT_ID;
-                                isMrValid = isMonorepo ?
-                                    utils_1.Descriptions.isMonorepoDescriptionValid(mr.description) :
-                                    utils_1.Descriptions.isDescriptionValid(mr.description);
-                                if (isMonorepo && !((_a = mr.labels) === null || _a === void 0 ? void 0 : _a.length))
-                                    isMrValid = false;
-                                if (!isMrValid)
-                                    invalidMrs.push(mr);
-                            }
-                            if (invalidMrs.length) {
-                                utils_1.Logger.logError("\n[".concat(project.title, "] has invalid MRs"));
-                                groupedByUser = lodash_1.default.groupBy(invalidMrs, function (mr) { return mr.author; });
-                                for (key in groupedByUser) {
-                                    utils_1.Logger.logMessage(key);
-                                    for (_c = 0, _d = groupedByUser[key]; _c < _d.length; _c++) {
-                                        mr = _d[_c];
-                                        utils_1.Logger.logMessage("- ".concat(mr.url));
-                                    }
+                        _loop_1 = function (project) {
+                            var invalidMrs, targetBranch, mergeRequestsTargetingDev, projectConfig, isMonorepo, _c, mergeRequestsTargetingDev_1, mr, errors, isMrValid, groupedByUser, key, _d, _e, _f, mr, errors, _g, errors_1, error;
+                            return __generator(this, function (_h) {
+                                switch (_h.label) {
+                                    case 0:
+                                        invalidMrs = [];
+                                        targetBranch = 'dev';
+                                        mergeRequestsTargetingDev = project.mergeRequests.filter(function (mergeRequest) {
+                                            return mergeRequest.targetBranch === targetBranch;
+                                        });
+                                        return [4 /*yield*/, this_1.service.getProjectConfig(project.id, targetBranch)];
+                                    case 1:
+                                        projectConfig = _h.sent();
+                                        isMonorepo = project.id.toString() === utils_1.ProjectIds.MONOREPO_PROJECT_ID;
+                                        for (_c = 0, mergeRequestsTargetingDev_1 = mergeRequestsTargetingDev; _c < mergeRequestsTargetingDev_1.length; _c++) {
+                                            mr = mergeRequestsTargetingDev_1[_c];
+                                            errors = utils_1.Descriptions.validate(mr.description, projectConfig);
+                                            isMrValid = errors.length === 0;
+                                            if (isMonorepo && !((_a = mr.labels) === null || _a === void 0 ? void 0 : _a.length))
+                                                isMrValid = false;
+                                            if (!isMrValid)
+                                                invalidMrs.push([mr, errors]);
+                                        }
+                                        if (invalidMrs.length) {
+                                            utils_1.Logger.logError("\n[".concat(project.title, "] has invalid MRs"));
+                                            groupedByUser = lodash_1.default.groupBy(invalidMrs, function (_a) {
+                                                var mr = _a[0];
+                                                return mr.author;
+                                            });
+                                            for (key in groupedByUser) {
+                                                utils_1.Logger.logMessage(key);
+                                                for (_d = 0, _e = groupedByUser[key]; _d < _e.length; _d++) {
+                                                    _f = _e[_d], mr = _f[0], errors = _f[1];
+                                                    utils_1.Logger.logMessage("- ".concat(mr.url));
+                                                    for (_g = 0, errors_1 = errors; _g < errors_1.length; _g++) {
+                                                        error = errors_1[_g];
+                                                        utils_1.Logger.logMessage("  - ".concat(error));
+                                                    }
+                                                }
+                                            }
+                                            cont = false;
+                                        }
+                                        return [2 /*return*/];
                                 }
-                                cont = false;
-                            }
-                        }
+                            });
+                        };
+                        this_1 = this;
+                        _i = 0, projects_1 = projects;
+                        _b.label = 2;
+                    case 2:
+                        if (!(_i < projects_1.length)) return [3 /*break*/, 5];
+                        project = projects_1[_i];
+                        return [5 /*yield**/, _loop_1(project)];
+                    case 3:
+                        _b.sent();
+                        _b.label = 4;
+                    case 4:
+                        _i++;
+                        return [3 /*break*/, 2];
+                    case 5:
                         if (cont)
                             utils_1.Logger.logSuccess('All MR descriptions are valid');
                         return [2 /*return*/, cont];

package/lib/src/tasks/ValidateMergeRequestTask.js

@@ -62,7 +62,7 @@ var ValidateMergeRequestTask = /** @class */ (function () {
     ValidateMergeRequestTask.prototype.run = function (options) {
         var _a;
         return __awaiter(this, void 0, void 0, function () {
-            var project, mergeRequestId, mergeRequest, isMonorepo, isDescriptionValid;
+            var project, mergeRequestId, mergeRequest, isMonorepo, projectConfig, isDescriptionValid;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
@@ -91,9 +91,10 @@ var ValidateMergeRequestTask = /** @class */ (function () {
                             Logger_1.Logger.logError('Monorepo MRs must have labels');
                             return [2 /*return*/, false];
                         }
-                        isDescriptionValid = isMonorepo ?
-                            utils_1.Descriptions.isMonorepoDescriptionValid(mergeRequest.description) :
-                            utils_1.Descriptions.isDescriptionValid(mergeRequest.description);
+                        return [4 /*yield*/, this.service.getProjectConfig(project.id, mergeRequest.targetBranch)];
+                    case 3:
+                        projectConfig = _b.sent();
+                        isDescriptionValid = utils_1.Descriptions.validate(mergeRequest.description, projectConfig).length === 0;
                         if (!isDescriptionValid) {
                             Logger_1.Logger.logError('Merge request description is invalid');
                             return [2 /*return*/, false];

package/lib/src/tasks/index.js

@@ -20,6 +20,7 @@ __exportStar(require("./CommitPackageVersionsTask"), exports);
 __exportStar(require("./CreateBranchTask"), exports);
 __exportStar(require("./CreateMergeRequestTask"), exports);
 __exportStar(require("./CreateReleaseNotesTask"), exports);
+__exportStar(require("./CreateTestingNotesTask"), exports);
 __exportStar(require("./InstallPackagesTask"), exports);
 __exportStar(require("./StartConsumingProjectBuildsTask"), exports);
 __exportStar(require("./StartMonorepoBuildTask"), exports);

package/lib/src/types.js

@@ -22,6 +22,7 @@ exports.TASKS = {
     CreateMergeRequestTask: Symbol.for('CreateMergeRequestTask'),
     ValidateDescriptionsTask: Symbol.for('ValidateDescriptionsTask'),
     CreateReleaseNotesTask: Symbol.for('CreateReleaseNotesTask'),
+    CreateTestingNotesTask: Symbol.for('CreateTestingNotesTask'),
     InstallPackagesTask: Symbol.for('InstallPackagesTask'),
     BumpPackagesTask: Symbol.for('BumpPackagesTask'),
     CommitPackageVersionsTask: Symbol.for('CommitPackageVersionsTask'),
@@ -38,6 +39,7 @@ exports.COMMANDS = {
     CreateBranchCommand: Symbol.for('CreateBranchCommand'),
     CreateMergeRequestCommand: Symbol.for('CreateMergeRequestCommand'),
     CreateReleaseNotesCommand: Symbol.for('CreateReleaseNotesCommand'),
+    CreateTestingNotesCommand: Symbol.for('CreateTestingNotesCommand'),
     InstallPackagesCommand: Symbol.for('InstallPackagesCommand'),
     BumpPackagesCommand: Symbol.for('BumpPackagesCommand'),
     ValidateMergeRequestCommand: Symbol.for('ValidateMergeRequestCommand'),

package/lib/src/utils/Csv.js

@@ -0,0 +1,54 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CsvFile = void 0;
+var format_1 = require("@fast-csv/format");
+var fs_extra_1 = __importDefault(require("fs-extra"));
+var CsvFile = /** @class */ (function () {
+    function CsvFile(opts) {
+        this.headers = opts.headers;
+        this.path = opts.path;
+        this.writeOpts = { headers: this.headers, includeEndRowDelimiter: true };
+    }
+    CsvFile.write = function (stream, rows, options) {
+        return new Promise(function (res, rej) {
+            (0, format_1.writeToStream)(stream, rows, options)
+                .on('error', function (err) { return rej(err); })
+                .on('finish', function () { return res(); });
+        });
+    };
+    CsvFile.prototype.create = function (rows) {
+        return CsvFile.write(fs_extra_1.default.createWriteStream(this.path), rows, __assign({}, this.writeOpts));
+    };
+    CsvFile.prototype.append = function (rows) {
+        return CsvFile.write(fs_extra_1.default.createWriteStream(this.path, { flags: 'a' }), rows, __assign(__assign({}, this.writeOpts), { 
+            // dont write the headers when appending
+            writeHeaders: false }));
+    };
+    CsvFile.prototype.read = function () {
+        var _this = this;
+        return new Promise(function (res, rej) {
+            fs_extra_1.default.readFile(_this.path, function (err, contents) {
+                if (err) {
+                    return rej(err);
+                }
+                return res(contents);
+            });
+        });
+    };
+    return CsvFile;
+}());
+exports.CsvFile = CsvFile;

package/lib/src/utils/Descriptions.js

@@ -1,67 +1,46 @@
 "use strict";
-var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
-    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
-        if (ar || !(i in from)) {
-            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
-            ar[i] = from[i];
-        }
-    }
-    return to.concat(ar || Array.prototype.slice.call(from));
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Descriptions = void 0;
-var VALID_HEADINGS = {
-    'dependencies': true,
-    'before release': true,
-    'customer changes': true,
-    'code changes': true,
-    'testing': true,
-    'notes': true,
-    'other': true
-};
-var VALID_MONOREPO_HEADINGS = {
-    'common': true,
-    'curator': true,
-    'library editor': true,
-    'lite': true,
-    'online': true,
-    'shared': true,
-    'styles': true,
-    'player': true,
-    'reports': true,
-    'analytics': true,
-    'tooling': true,
-    'testing': true,
-    'dependencies': true,
-    'notes': true,
-    'monorepo': true,
-    'before release': true
+var Headings = {
+    BeforeRelease: 'Before release',
+    Dependencies: 'Dependencies',
+    CodeChanges: 'Code changes',
+    CustomerChanges: 'Customer changes',
+    Testing: 'Testing',
+    Notes: 'Notes'
 };
-/**
- * Most of the ordering here doesn't matter, BUT "before release" and "dependencies" should always be
- * at the top so that they're more visible to whoever is managing the release.
- */
+var BASE_VALID_HEADINGS = [
+    Headings.BeforeRelease,
+    Headings.Dependencies,
+    Headings.Testing,
+    Headings.Notes
+];
+var PROJECT_VALID_HEADINGS = BASE_VALID_HEADINGS.concat([
+    Headings.CustomerChanges,
+    Headings.CodeChanges
+]);
+var PROJECT_REQUIRED_HEADINGS = [
+    Headings.Testing
+];
 var HEADING_ORDER = [
-    'before release',
-    'dependencies',
-    'notes',
-    'other',
-    'customer changes',
-    'code changes',
-    'lite',
-    'library editor',
-    'online',
-    'reports',
-    'curator',
-    'player',
-    'shared',
-    'analytics',
-    'styles',
-    'common',
-    'monorepo',
-    'tooling',
-    'testing'
+    Headings.BeforeRelease,
+    Headings.Dependencies,
+    Headings.CustomerChanges,
+    Headings.CodeChanges,
+    '*',
+    Headings.Testing,
+    Headings.Notes,
 ];
+function headingTransformer(heading) {
+    // Fix casing of known headings
+    var lowerHeading = heading.toLowerCase();
+    for (var i = 0; i < PROJECT_VALID_HEADINGS.length; i++) {
+        if (PROJECT_VALID_HEADINGS[i].toLowerCase() === lowerHeading)
+            return PROJECT_VALID_HEADINGS[i];
+    }
+    // No transform
+    return heading;
+}
 function toObject(lines, headingPrefix) {
     var obj = {};
     var currentHeading = 'other';
@@ -72,7 +51,7 @@ function toObject(lines, headingPrefix) {
             continue;
         if (line.startsWith(headingPrefix + ' ')) {
             // TODO: Potentially add heading transforms to capture multiple variants
-            currentHeading = line.toLowerCase().replace(headingPrefix, '').trim();
+            currentHeading = headingTransformer(line.replace(headingPrefix, '').trim());
             continue;
         }
         if (!obj[currentHeading])
@@ -95,47 +74,85 @@ function toObject(lines, headingPrefix) {
  * - Josh
  */
 function orderDescriptionHeadings(headings) {
-    var orderForIndexVals = __spreadArray([], HEADING_ORDER, true).reverse();
+    // Get the index of our wildcard where we put all the other headings into
+    var starIndex = HEADING_ORDER.indexOf('*');
+    if (starIndex === -1)
+        starIndex = HEADING_ORDER.length;
     return headings.sort(function (a, b) {
-        var aIndex = -orderForIndexVals.indexOf(a);
-        var bIndex = -orderForIndexVals.indexOf(b);
+        var aIndex = HEADING_ORDER.indexOf(a);
+        var bIndex = HEADING_ORDER.indexOf(b);
+        // Do normal sort logic if both are missing from heading order
+        if (aIndex === -1 && bIndex === -1) {
+            if (a < b)
+                return -1;
+            if (a > b)
+                return 1;
+            return 0;
+        }
+        if (aIndex === -1)
+            aIndex = starIndex;
+        if (bIndex === -1)
+            bIndex = starIndex;
         return aIndex - bIndex;
     });
 }
 exports.Descriptions = {
-    isDescriptionValid: function (description, headingPrefix, checkForTesting) {
-        if (headingPrefix === void 0) { headingPrefix = '#'; }
-        if (checkForTesting === void 0) { checkForTesting = true; }
-        if (!description.trim())
-            return false;
-        var obj = toObject(description.split('\n'), headingPrefix);
-        var keys = Object.keys(obj);
-        if (!(keys === null || keys === void 0 ? void 0 : keys.length))
-            return false;
-        if (keys.some(function (k) { return !VALID_HEADINGS[k]; }))
-            return false;
-        if (checkForTesting && obj['testing'] === undefined)
-            return false;
-        return true;
-    },
-    isMonorepoDescriptionValid: function (description) {
-        if (!description.trim())
-            return false;
+    validate: function (description, projectConfig) {
+        var validHeadings;
+        // If we are a monorepo, add in the valid sub project headings
+        if (projectConfig.monorepo.enabled) {
+            var subProjects = projectConfig.monorepo.validSubProjects;
+            validHeadings = BASE_VALID_HEADINGS.concat(subProjects);
+        }
+        else {
+            validHeadings = PROJECT_VALID_HEADINGS;
+        }
+        // Parse description
         var obj = toObject(description.split('\n'), '#');
-        var keys = Object.keys(obj);
-        if (!(keys === null || keys === void 0 ? void 0 : keys.length))
-            return false;
-        if (keys.some(function (k) { return !VALID_MONOREPO_HEADINGS[k]; }))
-            return false;
-        if (obj['testing'] === undefined)
-            return false;
-        var isValid = Object.keys(obj).every(function (key) {
-            if (key === 'dependencies' || key === 'testing')
-                return true;
-            var subValid = exports.Descriptions.isDescriptionValid(obj[key], '##', false);
-            return subValid;
+        var errors = this.validateProject(obj, {
+            validSections: validHeadings,
+            requiredSections: PROJECT_REQUIRED_HEADINGS
         });
-        return isValid;
+        if (!projectConfig.monorepo.enabled)
+            return errors;
+        var _loop_1 = function (subProject) {
+            // Ignore known headings
+            if (PROJECT_VALID_HEADINGS.indexOf(subProject) !== -1)
+                return "continue";
+            var subObj = toObject(obj[subProject].split('\n'), '##');
+            var subErrors = this_1.validateProject(subObj, {
+                validSections: PROJECT_VALID_HEADINGS,
+                requiredSections: []
+            });
+            errors = errors.concat(subErrors.map(function (x) { return "[".concat(subProject, "] ") + x; }));
+        };
+        var this_1 = this;
+        // If monorepo we need to check the sub projects are valid
+        for (var subProject in obj) {
+            _loop_1(subProject);
+        }
+        return errors;
+    },
+    validateProject: function (parsedDescription, options) {
+        // Parse description
+        var headings = Object.keys(parsedDescription);
+        // Must have at least one heading
+        if (headings.length < 1)
+            return ['Must have at least one section'];
+        var errors = [];
+        // Ensure all the headings are valid
+        for (var _i = 0, headings_1 = headings; _i < headings_1.length; _i++) {
+            var heading = headings_1[_i];
+            if (options.validSections.indexOf(heading) === -1)
+                errors.push("Invalid section: ".concat(heading));
+        }
+        // Ensure we have all required headings
+        for (var _a = 0, _b = options.requiredSections; _a < _b.length; _a++) {
+            var requiredSection = _b[_a];
+            if (parsedDescription[requiredSection] === undefined)
+                errors.push("Missing section: ".concat(requiredSection));
+        }
+        return errors;
     },
     getCombinedDescription: function (mergeRequests, headingPrefix) {
         if (headingPrefix === void 0) { headingPrefix = '#'; }
@@ -143,7 +160,7 @@ exports.Descriptions = {
             .filter(function (mr) { return mr.status === 'merged'; })
             .map(function (mr) { return toObject(mr.description.split('\n'), headingPrefix); });
         var obj = {};
-        var _loop_1 = function (descriptionObj) {
+        var _loop_2 = function (descriptionObj) {
             Object.keys(descriptionObj).forEach(function (key) {
                 if (!obj[key])
                     obj[key] = '';
@@ -152,16 +169,16 @@ exports.Descriptions = {
         };
         for (var _i = 0, descriptionObjs_1 = descriptionObjs; _i < descriptionObjs_1.length; _i++) {
             var descriptionObj = descriptionObjs_1[_i];
-            _loop_1(descriptionObj);
+            _loop_2(descriptionObj);
         }
         var description = '';
         var orderedHeadings = orderDescriptionHeadings(Object.keys(obj));
         orderedHeadings.forEach(function (key) {
-            if (key === 'notes')
+            if (key === Headings.Notes)
                 return;
             if (!obj[key])
                 return;
-            description += '\n' + headingPrefix + ' ' + key.charAt(0).toUpperCase() + key.slice(1) + '\n';
+            description += '\n' + headingPrefix + ' ' + key + '\n';
             description += obj[key];
         });
         return description;
@@ -173,7 +190,7 @@ exports.Descriptions = {
             .filter(function (mr) { return mr.status === 'merged'; })
             .map(function (mr) { return toObject(mr.description.split('\n'), '#'); });
         var combinedObj = {};
-        var _loop_2 = function (descriptionObj) {
+        var _loop_3 = function (descriptionObj) {
             Object.keys(descriptionObj).forEach(function (key) {
                 if (!combinedObj[key])
                     combinedObj[key] = {};
@@ -189,18 +206,18 @@ exports.Descriptions = {
         // For each property in each MR object, calculate it's H2 heading objects
         for (var _i = 0, descriptionObjs_2 = descriptionObjs; _i < descriptionObjs_2.length; _i++) {
             var descriptionObj = descriptionObjs_2[_i];
-            _loop_2(descriptionObj);
+            _loop_3(descriptionObj);
         }
         var orderedHeadings = orderDescriptionHeadings(Object.keys(combinedObj));
         // Build our description
         var description = '';
         orderedHeadings.forEach(function (key) {
-            if (key === 'notes')
+            if (key === Headings.Notes)
                 return;
-            description += '\n# ' + key.charAt(0).toUpperCase() + key.slice(1) + '\n';
+            description += '\n# ' + key + '\n';
             Object.keys(combinedObj[key]).forEach(function (subKey) {
-                if (key !== 'dependencies' && key !== 'testing')
-                    description += '\n## ' + subKey.charAt(0).toUpperCase() + subKey.slice(1) + '\n';
+                if (key !== Headings.Dependencies && key !== Headings.Testing)
+                    description += '\n## ' + subKey + '\n';
                 description += combinedObj[key][subKey];
             });
         });

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@clickview/ship-it",
-  "version": "0.0.10",
+  "version": "0.0.12",
   "description": "Release Manager",
   "main": "./lib/index.js",
   "bin": {
     "ship-it": "./lib/src/index.js"
   },
   "scripts": {
-    "start": "npm run lint && ts-node --files src/index.ts",
+    "start":  "npm run lint && ts-node --files src/index.ts",
     "build": "npm run lint && tsc -p . && tsc-alias -p tsconfig.json",
     "lint": "eslint . --ext .ts"
   },
@@ -21,6 +21,7 @@
     "@gitbeaker/node": "35.6.0",
     "chalk": "4.1.2",
     "commander": "9.1.0",
+    "fast-csv": "4.3.6",
     "fs-extra": "10.0.1",
     "inversify": "6.0.1",
     "lodash": "4.17.21",