@clickview/ship-it 0.0.5 → 0.0.6-rc.1

package/README.md

@@ -1 +1,32 @@
-TODO: Write an actual readme
+# Ship It
+
+## Prerequisites
+
+* NodeJS (and npm)
+* Access to the ClickView organization on [npm](https://www.npmjs.com). You will need to add an npm auth token to a global or local `.npmrc` file
+* Add the `Ship It` user as a `Developer` to each GitLab project you would like to manage using the Ship It CLI
+
+## Getting Started
+
+```
+git clone https://gitlab.cvinternal.net/front-end/ship-it.git
+cd ship-it
+npm install
+```
+
+After installation, you can run `npm run start -- help` for a list of Shit Commands.
+
+## Commands
+
+The available commands are listed below. If you run into issues check that you have met all the [prerequisites](#prerequisites) first.
+
+### Status
+
+* Command: `npm run start -- status -p [projectId] -m [milestone]`
+* Example: `npm run start -- status -p 887 -m T3`
+
+Get the status of all MRs in a milestone. You can run this command at any time to check whether a project's miletone is ready for release.
+
+You can find your numeric project id from your project page on GitLab.
+
+

package/lib/src/api-clients/git-lab/GitLabApiClient.js

@@ -55,6 +55,8 @@ var node_1 = require("@gitbeaker/node");
 var types_1 = require("../../types");
 var errors_1 = require("../../errors");
 var GitLabMapper_1 = require("./GitLabMapper");
+var GroupIds_1 = require("../../utils/GroupIds");
+var GitLabMemberIds_1 = require("../../constants/GitLabMemberIds");
 var GitLabApiClient = /** @class */ (function () {
     function GitLabApiClient(config) {
         this.config = config;
@@ -306,7 +308,8 @@ var GitLabApiClient = /** @class */ (function () {
                 switch (_a.label) {
                     case 0: return [4 /*yield*/, this.client.MergeRequests.create(projectId, sourceBranch, targetBranch, title, {
                             description: description,
-                            milestoneId: milestone.id
+                            milestoneId: milestone.id,
+                            assigneeId: GitLabMemberIds_1.GitLabMemberIds.SHIP_IT
                         })];
                     case 1:
                         mergeRequest = _a.sent();
@@ -364,13 +367,19 @@ var GitLabApiClient = /** @class */ (function () {
     };
     GitLabApiClient.prototype.getMilestone = function (projectId, milestoneName) {
         return __awaiter(this, void 0, void 0, function () {
-            var milestones, milestone;
+            var groupMilestones, milestone, projectMilestones;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.client.ProjectMilestones.all(projectId)];
+                    case 0: return [4 /*yield*/, this.client.GroupMilestones.all(GroupIds_1.GroupIds.CLICKVIEW)];
                     case 1:
-                        milestones = _a.sent();
-                        milestone = milestones.find(function (milestone) { return milestone.title === milestoneName; });
+                        groupMilestones = _a.sent();
+                        milestone = groupMilestones.find(function (milestone) { return milestone.title === milestoneName; });
+                        if (milestone)
+                            return [2 /*return*/, GitLabMapper_1.GitLabMapper.milestone(milestone)];
+                        return [4 /*yield*/, this.client.ProjectMilestones.all(projectId)];
+                    case 2:
+                        projectMilestones = _a.sent();
+                        milestone = projectMilestones.find(function (milestone) { return milestone.title === milestoneName; });
                         if (!milestone)
                             return [2 /*return*/, null];
                         return [2 /*return*/, GitLabMapper_1.GitLabMapper.milestone(milestone)];

package/lib/src/commands/StatusCommand.js

@@ -53,15 +53,29 @@ require("reflect-metadata");
 var inversify_1 = require("inversify");
 var types_1 = require("../types");
 var StatusCommand = /** @class */ (function () {
-    function StatusCommand(validateTask) {
+    function StatusCommand(validateTask, validateDescriptionsTask, validateCommitsTask) {
         this.validateTask = validateTask;
+        this.validateDescriptionsTask = validateDescriptionsTask;
+        this.validateCommitsTask = validateCommitsTask;
     }
     StatusCommand.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.validateTask.run(options)];
-                    case 1: return [2 /*return*/, _a.sent()];
+                    case 1:
+                        cont = _a.sent();
+                        // Check if we want to continue with inquirer?
+                        if (!cont)
+                            return [2 /*return*/, false];
+                        return [4 /*yield*/, this.validateDescriptionsTask.run(options)];
+                    case 2:
+                        cont = _a.sent();
+                        if (!cont)
+                            return [2 /*return*/, false];
+                        return [4 /*yield*/, this.validateCommitsTask.run(options)];
+                    case 3: return [2 /*return*/, _a.sent()];
                 }
             });
         });
@@ -69,7 +83,9 @@ var StatusCommand = /** @class */ (function () {
     StatusCommand = __decorate([
         (0, inversify_1.injectable)(),
         __param(0, (0, inversify_1.inject)(types_1.TASKS.ValidateTask)),
-        __metadata("design:paramtypes", [Object])
+        __param(1, (0, inversify_1.inject)(types_1.TASKS.ValidateDescriptionsTask)),
+        __param(2, (0, inversify_1.inject)(types_1.TASKS.ValidateCommitsTask)),
+        __metadata("design:paramtypes", [Object, Object, Object])
     ], StatusCommand);
     return StatusCommand;
 }());

package/lib/src/constants/GitLabMemberIds.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GitLabMemberIds = void 0;
+exports.GitLabMemberIds = {
+    SHIP_IT: 68
+};

package/lib/src/tasks/ValidateCommitsTask.js

@@ -60,32 +60,38 @@ var ValidateCommitsTask = /** @class */ (function () {
     }
     ValidateCommitsTask.prototype.run = function (options) {
         return __awaiter(this, void 0, void 0, function () {
-            var projects, cont, _i, projects_1, project, tag, devCommits, shouldCherryPick;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var projects, cont, _i, projects_1, project, _a, branch, tag, devCommits, shouldCherryPick;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
                     case 0:
                         utils_1.Logger.logTask('Validating dev commits');
                         return [4 /*yield*/, this.service.getProjects(options)];
                     case 1:
-                        projects = _a.sent();
+                        projects = _b.sent();
                         cont = true;
                         _i = 0, projects_1 = projects;
-                        _a.label = 2;
+                        _b.label = 2;
                     case 2:
                         if (!(_i < projects_1.length)) return [3 /*break*/, 6];
                         project = projects_1[_i];
                         return [4 /*yield*/, this.service.getNextBranchInfo(project.id, options.version)];
                     case 3:
-                        tag = (_a.sent()).tag;
+                        _a = _b.sent(), branch = _a.branch, tag = _a.tag;
+                        /**
+                         * If the release branch already exists, this can be skipped as this
+                         * validation is only required when creating a new release
+                         */
+                        if (branch)
+                            return [3 /*break*/, 5];
                         return [4 /*yield*/, this.service.getDevCommitsSince(project.id, tag.target)];
                     case 4:
-                        devCommits = _a.sent();
+                        devCommits = _b.sent();
                         shouldCherryPick = utils_1.Commits.shouldCherryPick(project, devCommits);
                         if (shouldCherryPick) {
                             utils_1.Logger.logError("[".concat(project.title, "]: Requires cherrypicking"));
                             cont = false;
                         }
-                        _a.label = 5;
+                        _b.label = 5;
                     case 5:
                         _i++;
                         return [3 /*break*/, 2];

package/lib/src/tasks/ValidateTask.js

@@ -75,7 +75,7 @@ var ValidateTask = /** @class */ (function () {
     }
     ValidateTask.prototype.run = function (options) {
         return __awaiter(this, void 0, void 0, function () {
-            var projects, cont, _loop_1, _i, projects_1, project;
+            var projects, cont, _loop_1, this_1, _i, projects_1, project;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -86,75 +86,137 @@ var ValidateTask = /** @class */ (function () {
                         utils_1.Logger.logMessage("Found ".concat(projects.length, " projects that need to be released"));
                         cont = true;
                         _loop_1 = function (project) {
-                            var groupedMRs = lodash_1.default.groupBy(project.mergeRequests, function (mr) { return mr.status; });
-                            var count = Object.keys(groupedMRs).reduce(function (prev, current) {
-                                var _a;
-                                return __assign(__assign({}, prev), (_a = {}, _a[current] = groupedMRs[current].length, _a));
-                            }, {});
-                            var ready = !count.opened || count.opened === 0;
-                            /**
-                             * Any MRs that are not targeting dev should not have a milestone
-                             */
-                            var nonDevMrs = project.mergeRequests.filter(function (mr) { return mr.targetBranch !== 'dev'; });
-                            if (nonDevMrs.length)
-                                ready = false;
-                            if (!ready)
-                                cont = false;
-                            if (ready) {
-                                utils_1.Logger.logSuccess("[".concat(project.title, "] READY"));
-                            }
-                            else {
-                                var message = "[".concat(project.title, "] NOT READY");
-                                if (count.opened)
-                                    message += " Contains ".concat(count.opened, " Open MR(s)");
-                                if (nonDevMrs)
-                                    message += " Contains ".concat(nonDevMrs.length, " MR(s) not targeting dev");
-                                utils_1.Logger.logError(message);
-                            }
+                            var groupedMRs, count, ready, wrongTargetMrs, message;
+                            return __generator(this, function (_b) {
+                                switch (_b.label) {
+                                    case 0:
+                                        groupedMRs = lodash_1.default.groupBy(project.mergeRequests, function (mr) { return mr.status; });
+                                        count = Object.keys(groupedMRs).reduce(function (prev, current) {
+                                            var _a;
+                                            return __assign(__assign({}, prev), (_a = {}, _a[current] = groupedMRs[current].length, _a));
+                                        }, {});
+                                        ready = !count.opened || count.opened === 0;
+                                        return [4 /*yield*/, this_1.getMRsTargetingWrongBranch(project, options.version)];
+                                    case 1:
+                                        wrongTargetMrs = _b.sent();
+                                        if (wrongTargetMrs.length)
+                                            ready = false;
+                                        if (!ready)
+                                            cont = false;
+                                        if (ready) {
+                                            utils_1.Logger.logSuccess("[".concat(project.title, "] READY"));
+                                        }
+                                        else {
+                                            message = "[".concat(project.title, "] NOT READY");
+                                            if (count.opened)
+                                                message += " Contains ".concat(count.opened, " Open MR(s)");
+                                            if (wrongTargetMrs)
+                                                message += " Contains ".concat(wrongTargetMrs.length, " MR(s) not targeting dev or release branch");
+                                            utils_1.Logger.logError(message);
+                                        }
+                                        return [2 /*return*/];
+                                }
+                            });
                         };
-                        for (_i = 0, projects_1 = projects; _i < projects_1.length; _i++) {
-                            project = projects_1[_i];
-                            _loop_1(project);
-                        }
-                        if (!cont) {
-                            this.logNotReady(projects);
-                            return [2 /*return*/, false];
-                        }
+                        this_1 = this;
+                        _i = 0, projects_1 = projects;
+                        _a.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:
+                        _a.sent();
+                        _a.label = 4;
+                    case 4:
+                        _i++;
+                        return [3 /*break*/, 2];
+                    case 5:
+                        if (!!cont) return [3 /*break*/, 7];
+                        return [4 /*yield*/, this.logNotReady(projects, options.version)];
+                    case 6:
+                        _a.sent();
+                        return [2 /*return*/, false];
+                    case 7:
                         utils_1.Logger.logSuccess('\nRelease is ready to go out');
                         return [2 /*return*/, true];
                 }
             });
         });
     };
-    ValidateTask.prototype.logNotReady = function (projects) {
-        utils_1.Logger.logError("\nThis release is NOT READY to go out, here are the outstanding MRs: \n");
-        var allNotReadyMrs = [];
-        var allNonDevMrs = [];
-        for (var _i = 0, projects_2 = projects; _i < projects_2.length; _i++) {
-            var project = projects_2[_i];
-            var notReadyMrs = project.mergeRequests.filter(function (mr) { return mr.status === 'opened'; });
-            var nonDevMrs = project.mergeRequests.filter(function (mr) { return mr.targetBranch !== 'dev'; });
-            if (notReadyMrs.length)
-                allNotReadyMrs.push.apply(allNotReadyMrs, notReadyMrs);
-            if (nonDevMrs.length)
-                allNonDevMrs.push.apply(allNonDevMrs, nonDevMrs);
-        }
-        var groupedByUser = lodash_1.default.groupBy(allNotReadyMrs, function (mr) { return mr.assignee; });
-        for (var key in groupedByUser) {
-            var name = key;
-            if (!name || name === 'undefined')
-                name = 'No Assignee';
-            utils_1.Logger.logMessage(name);
-            for (var _a = 0, _b = groupedByUser[key]; _a < _b.length; _a++) {
-                var mr = _b[_a];
-                utils_1.Logger.logMessage("- ".concat(mr.url));
-            }
-        }
-        if (allNonDevMrs.length) {
-            utils_1.Logger.logMessage('\nMRs that are not targeting dev\n');
-            allNonDevMrs.forEach(function (mr) { return utils_1.Logger.logError("- ".concat(mr.url)); });
-        }
-        utils_1.Logger.logMessage('\n');
+    ValidateTask.prototype.logNotReady = function (projects, version) {
+        return __awaiter(this, void 0, void 0, function () {
+            var allNotReadyMrs, allWrongTargetMrs, _i, projects_2, project, notReadyMrs, wrongTargetMrs, groupedByUser, key, name, _a, _b, mr;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        utils_1.Logger.logError("\nThis release is NOT READY to go out, here are the outstanding MRs: \n");
+                        allNotReadyMrs = [];
+                        allWrongTargetMrs = [];
+                        _i = 0, projects_2 = projects;
+                        _c.label = 1;
+                    case 1:
+                        if (!(_i < projects_2.length)) return [3 /*break*/, 4];
+                        project = projects_2[_i];
+                        notReadyMrs = project.mergeRequests.filter(function (mr) { return mr.status === 'opened'; });
+                        return [4 /*yield*/, this.getMRsTargetingWrongBranch(project, version)];
+                    case 2:
+                        wrongTargetMrs = _c.sent();
+                        if (notReadyMrs.length)
+                            allNotReadyMrs.push.apply(allNotReadyMrs, notReadyMrs);
+                        if (wrongTargetMrs.length)
+                            allWrongTargetMrs.push.apply(allWrongTargetMrs, wrongTargetMrs);
+                        _c.label = 3;
+                    case 3:
+                        _i++;
+                        return [3 /*break*/, 1];
+                    case 4:
+                        groupedByUser = lodash_1.default.groupBy(allNotReadyMrs, function (mr) { return mr.assignee; });
+                        for (key in groupedByUser) {
+                            name = key;
+                            if (!name || name === 'undefined')
+                                name = 'No Assignee';
+                            utils_1.Logger.logMessage(name);
+                            for (_a = 0, _b = groupedByUser[key]; _a < _b.length; _a++) {
+                                mr = _b[_a];
+                                utils_1.Logger.logMessage("- ".concat(mr.url));
+                            }
+                        }
+                        if (allWrongTargetMrs.length) {
+                            utils_1.Logger.logMessage('\nMRs that are not targeting dev or release branch\n');
+                            allWrongTargetMrs.forEach(function (mr) { return utils_1.Logger.logError("- ".concat(mr.url)); });
+                        }
+                        utils_1.Logger.logMessage('\n');
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Finds any MRs with the milestone that are either not targeting dev
+     * or the release branch if one is already made
+     */
+    ValidateTask.prototype.getMRsTargetingWrongBranch = function (project, version) {
+        return __awaiter(this, void 0, void 0, function () {
+            var nonDevMrs, _a, premadeRelease, releaseName, nonDevAndReleaseMrs;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        nonDevMrs = project.mergeRequests.filter(function (mr) {
+                            return mr.targetBranch !== 'dev';
+                        });
+                        if (!nonDevMrs.length)
+                            return [2 /*return*/, []];
+                        return [4 /*yield*/, this.service.getNextBranchInfo(project.id, version)];
+                    case 1:
+                        _a = _b.sent(), premadeRelease = _a.branch, releaseName = _a.branchName;
+                        if (!premadeRelease)
+                            return [2 /*return*/, nonDevMrs];
+                        nonDevAndReleaseMrs = nonDevMrs.filter(function (mr) { return mr.targetBranch !== releaseName; });
+                        return [2 /*return*/, nonDevAndReleaseMrs];
+                }
+            });
+        });
     };
     ValidateTask = __decorate([
         (0, inversify_1.injectable)(),

package/lib/src/utils/GroupIds.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GroupIds = void 0;
+exports.GroupIds = {
+    CLICKVIEW: 1069
+};

package/lib/src/utils/ProjectIds.js

@@ -8,7 +8,10 @@ exports.PROJECT_NAMES = {
     curator: '62',
     cloud: '534',
     reports: '970',
-    lite: '822'
+    lite: '822',
+    android: '887',
+    integrationsapi: '850',
+    auth: '54'
 };
 exports.ProjectIds = {
     MONOREPO_PROJECT_ID: '798',

package/package.json

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