@clickview/ship-it 0.0.31 → 0.0.32

package/config.json

@@ -1,6 +1,6 @@
 {
   "gitLab": {
-    "accessToken": "glpat-i-knsmg2m7c8oMd-_xNn",
+    "accessToken": "glpat-d9TACyfNj3uaetfbGiPp",
     "url": "https://gitlab.cvinternal.net"
   },
   "teamCity": {

package/lib/config.json

@@ -1,6 +1,6 @@
 {
     "gitLab": {
-        "accessToken": "glpat-i-knsmg2m7c8oMd-_xNn",
+        "accessToken": "glpat-d9TACyfNj3uaetfbGiPp",
         "url": "https://gitlab.cvinternal.net"
     },
     "teamCity": {

package/lib/src/commands/CreateNotesAuditCommand.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.CreateNotesAuditCommand = void 0;
+require("reflect-metadata");
+var inversify_1 = require("inversify");
+var types_1 = require("../types");
+var CreateNotesAuditCommand = /** @class */ (function () {
+    function CreateNotesAuditCommand(validateDescriptionsTask, createTestingNotesTask) {
+        this.validateDescriptionsTask = validateDescriptionsTask;
+        this.createNotesAuditTask = createTestingNotesTask;
+    }
+    CreateNotesAuditCommand.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.createNotesAuditTask.run(options)];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    CreateNotesAuditCommand = __decorate([
+        (0, inversify_1.injectable)(),
+        __param(0, (0, inversify_1.inject)(types_1.TASKS.ValidateDescriptionsTask)),
+        __param(1, (0, inversify_1.inject)(types_1.TASKS.CreateNotesAuditTask)),
+        __metadata("design:paramtypes", [Object, Object])
+    ], CreateNotesAuditCommand);
+    return CreateNotesAuditCommand;
+}());
+exports.CreateNotesAuditCommand = CreateNotesAuditCommand;

package/lib/src/commands/index.js

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

package/lib/src/constants/CommandTypeMapping.js

@@ -9,7 +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,
+    'create-notes-audit': types_1.COMMANDS.CreateNotesAuditCommand,
     'install-packages': types_1.COMMANDS.InstallPackagesCommand,
     'bump-packages': types_1.COMMANDS.BumpPackagesCommand,
     'validate-mr': types_1.COMMANDS.ValidateMergeRequestCommand,

package/lib/src/inversify.config.js

@@ -41,7 +41,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.CreateNotesAuditTask).to(tasks_1.CreateNotesAuditTask);
     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);
@@ -61,7 +61,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.CreateNotesAuditCommand).to(commands_1.CreateNotesAuditCommand);
     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/startup/SetupCommands.js

@@ -47,8 +47,7 @@ function setupCommands(program, container) {
     addMilestoneCommand('version', 'Display the versions that will be used for the release');
     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('create-notes-audit', 'Builds a spreadsheet of all the customer changes and who wrote them.');
     addMilestoneCommand('tag-master', 'Tags master for all release MRs that are part of a milestone');
     addMilestoneCommand('create-trello-cards', 'Creates the cards on the ship-it trello board for all projects that are part of a milestone');
     program.command('status')

package/lib/src/tasks/CreateNotesAuditTask.js

@@ -0,0 +1,140 @@
+"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.CreateNotesAuditTask = 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 CreateNotesAuditTask = /** @class */ (function () {
+    function CreateNotesAuditTask(service) {
+        this.service = service;
+    }
+    CreateNotesAuditTask.prototype.run = function (options) {
+        return __awaiter(this, void 0, void 0, function () {
+            var projects, projectTestingNotes, _i, projects_1, project, _a, _b, mr, description, outputPath, error_1, csv;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        utils_1.Logger.logTask('Creating release notes audit');
+                        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];
+                            for (_a = 0, _b = project.mergeRequests; _a < _b.length; _a++) {
+                                mr = _b[_a];
+                                description = '';
+                                if (project.id.toString() === utils_1.ProjectIds.MONOREPO_PROJECT_ID) {
+                                    description = utils_1.Descriptions.getMonorepoDescriptionSection('CustomerChanges', mr);
+                                }
+                                else {
+                                    description = utils_1.Descriptions.getDescriptionSection('CustomerChanges', mr);
+                                }
+                                /**
+                                 * Discard and MRs without customer changes
+                                 */
+                                if (!description)
+                                    continue;
+                                projectTestingNotes.push({
+                                    projectName: project.title,
+                                    mrTitle: mr.title,
+                                    mrAuthor: mr.author,
+                                    mrAssignee: mr.assignee,
+                                    mrUrl: mr.url,
+                                    notes: 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, " Notes Audit.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];
+                }
+            });
+        });
+    };
+    CreateNotesAuditTask = __decorate([
+        (0, inversify_1.injectable)(),
+        __param(0, (0, inversify_1.inject)(types_1.SERVICES.GitLabService)),
+        __metadata("design:paramtypes", [services_1.GitLabService])
+    ], CreateNotesAuditTask);
+    return CreateNotesAuditTask;
+}());
+exports.CreateNotesAuditTask = CreateNotesAuditTask;

package/lib/src/tasks/index.js

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

package/lib/src/types.js

@@ -28,7 +28,7 @@ exports.TASKS = {
     CreateMergeRequestTask: Symbol.for('CreateMergeRequestTask'),
     ValidateDescriptionsTask: Symbol.for('ValidateDescriptionsTask'),
     CreateReleaseNotesTask: Symbol.for('CreateReleaseNotesTask'),
-    CreateTestingNotesTask: Symbol.for('CreateTestingNotesTask'),
+    CreateNotesAuditTask: Symbol.for('CreateNotesAuditTask'),
     InstallPackagesTask: Symbol.for('InstallPackagesTask'),
     BumpPackagesTask: Symbol.for('BumpPackagesTask'),
     CommitPackageVersionsTask: Symbol.for('CommitPackageVersionsTask'),
@@ -46,7 +46,7 @@ exports.COMMANDS = {
     CreateBranchCommand: Symbol.for('CreateBranchCommand'),
     CreateMergeRequestCommand: Symbol.for('CreateMergeRequestCommand'),
     CreateReleaseNotesCommand: Symbol.for('CreateReleaseNotesCommand'),
-    CreateTestingNotesCommand: Symbol.for('CreateTestingNotesCommand'),
+    CreateNotesAuditCommand: Symbol.for('CreateNotesAuditCommand'),
     InstallPackagesCommand: Symbol.for('InstallPackagesCommand'),
     BumpPackagesCommand: Symbol.for('BumpPackagesCommand'),
     ValidateMergeRequestCommand: Symbol.for('ValidateMergeRequestCommand'),

package/lib/src/utils/Descriptions.js

@@ -183,6 +183,16 @@ exports.Descriptions = {
         });
         return description;
     },
+    getDescriptionSection: function (heading, mergeRequest) {
+        var descriptionObj = toObject(mergeRequest.description.split('\n'), '#');
+        var obj = {};
+        Object.keys(descriptionObj).forEach(function (key) {
+            if (!obj[key])
+                obj[key] = '';
+            obj[key] += descriptionObj[key] + '\n';
+        });
+        return obj[Headings[heading]];
+    },
     // TODO: This isn't readable, it needs to be refactored
     getMonorepoCombinedDescription: function (mergeRequests) {
         // Get an object where H1s are properties
@@ -223,6 +233,33 @@ exports.Descriptions = {
         });
         return description;
     },
+    getMonorepoDescriptionSection: function (subHeading, mergeRequest) {
+        var descriptionObj = toObject(mergeRequest.description.split('\n'), '#');
+        var obj = {};
+        Object.keys(descriptionObj).forEach(function (key) {
+            if (!obj[key])
+                obj[key] = {};
+            var combinedSubObj = toObject(descriptionObj[key].split('\n'), '##');
+            Object.keys(combinedSubObj).forEach(function (subKey) {
+                if (!obj[key][subKey])
+                    obj[key][subKey] = '';
+                obj[key][subKey] += combinedSubObj[subKey];
+            });
+        });
+        // Build our description
+        var description = '';
+        Object.keys(obj).forEach(function (key) {
+            if (key === Headings.Notes)
+                return;
+            Object.keys(obj[key]).forEach(function (subKey) {
+                if (subKey !== Headings[subHeading])
+                    return;
+                description += '\n# ' + key + '\n';
+                description += obj[key][subKey];
+            });
+        });
+        return description;
+    },
     bumpHeadings: function (description) {
         var lines = description.split('\n');
         var bumpedDescription = '';

package/package.json

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