@clickview/ship-it 0.0.8 → 0.0.9

package/README.md

@@ -1,5 +1,17 @@
 # Ship It
 
+## Introduction
+
+"Ship It" is a CLI tool that was created to automate aspects of our release workflow.
+
+### How To Manage A Release
+
+If you are here to learn how to manage a release, please see [this document](https://clickview.quip.com/DbEyAaVK8sqB/Release-Manager-Checklist) instead.
+
+### How To Contribute
+
+If you are here instead of learn about or contribute to this project, then you're in the right place! Keep reading :)
+
 ## Prerequisites
 
 * NodeJS (and npm)
@@ -14,26 +26,23 @@ cd ship-it
 npm install
 ```
 
-After installation, you can run `npm run start -- help` for a list of Shit Commands.
-
-## Commands
+After installation, you can run `npm run start -- help` to see the full list of commands.
 
-The available commands are listed below. If you run into issues check that you have met all the [prerequisites](#prerequisites) first.
+## Contributing
 
-Note down the numeric project id from your project's homepage on GitLab - this will be useful for running some of the commands below.
+### Open Issues
 
-### Status
+All bugs / feature requests are tracked in the [issues](https://gitlab.cvinternal.net/clickview/front-end/ship-it/-/issues) section of this project.
 
-* Command: `npm run start -- status -m milestone [-p projectId]`
-* Example: `npm run start -- status -m T3 -p 887`
+Anyone is free to pick up an issue and work on it at will! Don't be afraid, the TypeScript won't bite.
 
-Get the status of all MRs in a milestone. You can run this command at any time to check whether a miletone is ready for release. You can also limit the status check to a particular project.
+### Project Architecture
 
-### Create Notes
+Each CLI command is defined in the `startup/SetupCommands.ts` file.
 
-* Command: `npm run start -- create-notes -m milestone [-p projectId]`
-* Example: `npm run start -- create-notes -m U3 -p 887`
+Each command maps to a particular TypeScript class in the `commands` directory.
+These command classes typically just sequentially run a set of "tasks", where each "task" can be shared across different commands.
+Each task also exists as a TypeScript class under the `tasks` directory.
 
-Generate release notes for all projects targeting a particular milestone. You can also pass in a `projectId` to generate notes for a single project only.
+All code written in this project is intended to be highly reusable! If you are contributing a new command or updating an existing one, be sure to see if the code you're looking for already exists.
 
-The notes will be saved in a `dist` folder in markdown format.

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

@@ -155,6 +155,7 @@ var GitLabApiClient = /** @class */ (function () {
                             id: projectId,
                             name: release.name,
                             tag_name: release.tag,
+                            tag_message: release.milestones,
                             description: release.description,
                             ref: release.ref
                         })];

package/lib/src/commands/ListProjectsCommand.js

@@ -0,0 +1,76 @@
+"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.ListProjectsCommand = void 0;
+require("reflect-metadata");
+var inversify_1 = require("inversify");
+var types_1 = require("../types");
+var ListProjectsCommand = /** @class */ (function () {
+    function ListProjectsCommand(listProjectsTask) {
+        this.listProjectsTask = listProjectsTask;
+    }
+    ListProjectsCommand.prototype.run = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.listProjectsTask.run()];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    ListProjectsCommand = __decorate([
+        (0, inversify_1.injectable)(),
+        __param(0, (0, inversify_1.inject)(types_1.TASKS.ListProjectsTask)),
+        __metadata("design:paramtypes", [Object])
+    ], ListProjectsCommand);
+    return ListProjectsCommand;
+}());
+exports.ListProjectsCommand = ListProjectsCommand;

package/lib/src/commands/index.js

@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./BumpPackagesCommand"), exports);
 __exportStar(require("./CreateBranchCommand"), exports);
 __exportStar(require("./CreateMergeRequestCommand"), exports);
+__exportStar(require("./ListProjectsCommand"), exports);
 __exportStar(require("./CreateReleaseNotesCommand"), exports);
 __exportStar(require("./InstallPackagesCommand"), exports);
 __exportStar(require("./ReleaseCommand"), exports);

package/lib/src/constants/CommandTypeMapping.js

@@ -13,5 +13,6 @@ exports.CommandTypeMapping = {
     'bump-packages': types_1.COMMANDS.BumpPackagesCommand,
     'validate-mr': types_1.COMMANDS.ValidateMergeRequestCommand,
     'start-consuming-project-builds': types_1.COMMANDS.StartConsumingProjectBuildsCommand,
-    'tag-master': types_1.COMMANDS.TagMasterCommand
+    'tag-master': types_1.COMMANDS.TagMasterCommand,
+    'list-projects': types_1.COMMANDS.ListProjectsCommand
 };

package/lib/src/constants/ProjectNames.js

@@ -50,8 +50,11 @@ exports.PROJECT_NAMES = {
         users: '914',
         tvweb: '161',
         cloud247web: '161',
+        clients: '897',
+        goodstuff: '1002'
     },
     mobile: {
-        android: '887'
+        android: '887',
+        interactiveforios: '395'
     }
 };

package/lib/src/interfaces/ProjectNames.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/src/interfaces/command-options/BaseCommandOptions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/src/interfaces/index.js

@@ -23,3 +23,4 @@ __exportStar(require("./MergeRequestState"), exports);
 __exportStar(require("./ShipItCommand"), exports);
 __exportStar(require("./ShipItTask"), exports);
 __exportStar(require("./VersionType"), exports);
+__exportStar(require("./ProjectNames"), exports);

package/lib/src/inversify.config.js

@@ -41,6 +41,7 @@ function createContainer(config) {
     container.bind(types_1.TASKS.ValidateMergeRequestTask).to(tasks_1.ValidateMergeRequestTask);
     container.bind(types_1.TASKS.StartMonorepoBuildTask).to(tasks_1.StartMonorepoBuildTask);
     container.bind(types_1.TASKS.TagMasterTask).to(tasks_1.TagMasterTask);
+    container.bind(types_1.TASKS.ListProjectsTask).to(tasks_1.ListProjectsTask);
     container.bind(types_1.TASKS.StartConsumingProjectBuildsTask)
         .to(tasks_1.StartConsumingProjectBuildsTask);
     /**
@@ -56,6 +57,7 @@ function createContainer(config) {
     container.bind(types_1.COMMANDS.BumpPackagesCommand).to(commands_1.BumpPackagesCommand);
     container.bind(types_1.COMMANDS.ValidateMergeRequestCommand).to(commands_1.ValidateMergeRequestCommand);
     container.bind(types_1.COMMANDS.TagMasterCommand).to(commands_1.TagMasterCommand);
+    container.bind(types_1.COMMANDS.ListProjectsCommand).to(commands_1.ListProjectsCommand);
     container.bind(types_1.COMMANDS.StartConsumingProjectBuildsCommand)
         .to(commands_1.StartConsumingProjectBuildsCommand);
     return container;

package/lib/src/services/GitLabService.js

@@ -205,19 +205,20 @@ var GitLabService = /** @class */ (function () {
     };
     GitLabService.prototype.getDevCommitsSince = function (projectId, sinceSha) {
         return __awaiter(this, void 0, void 0, function () {
-            var commits, lastDevCommit, title;
+            var commits, mergeCommitIndex;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0: return [4 /*yield*/, this.apiClient.getCommitsSince(projectId, 'dev', sinceSha)];
                     case 1:
                         commits = _a.sent();
-                        lastDevCommit = lodash_1.default.last(commits);
-                        title = lastDevCommit === null || lastDevCommit === void 0 ? void 0 : lastDevCommit.title.toLowerCase();
-                        if ((title === null || title === void 0 ? void 0 : title.includes('merge')) &&
-                            (title === null || title === void 0 ? void 0 : title.includes('master')) &&
-                            (title === null || title === void 0 ? void 0 : title.includes('dev'))) {
-                            commits.pop();
-                        }
+                        mergeCommitIndex = commits.findIndex(function (commit) {
+                            var title = commit.title.toLowerCase();
+                            return title.includes('merge') &&
+                                title.includes('master') &&
+                                title.includes('dev');
+                        });
+                        if (mergeCommitIndex > -1)
+                            commits.splice(mergeCommitIndex, 1);
                         /**
                          * This is commented out right now because of a problem with the logic of this approach of validating MRs.
                          * We need to find a way to fetch all commits that will be included in this release. Leaving this commented

package/lib/src/startup/SetupCommands.js

@@ -119,5 +119,8 @@ function setupCommands(program, container) {
             }
         });
     }); });
+    program.command('list-projects')
+        .description('Displays a list of all project names that can be used with the -p argument')
+        .action(getAction('list-projects'));
 }
 exports.setupCommands = setupCommands;

package/lib/src/tasks/BumpVersionTxtTask.js

@@ -54,6 +54,7 @@ var inversify_1 = require("inversify");
 var Logger_1 = require("../utils/Logger");
 var types_1 = require("../types");
 var services_1 = require("../services");
+var constants_1 = require("../constants");
 var BumpVersionTxtTask = /** @class */ (function () {
     function BumpVersionTxtTask(service) {
         this.service = service;
@@ -73,6 +74,8 @@ var BumpVersionTxtTask = /** @class */ (function () {
                     case 2:
                         if (!(_i < projects_1.length)) return [3 /*break*/, 6];
                         project = projects_1[_i];
+                        if (this.skip(project.id))
+                            return [2 /*return*/, false];
                         return [4 /*yield*/, this.service.getNextBranchInfo(project.id, options.version)];
                     case 3:
                         _a = _b.sent(), nextVersion = _a.nextVersion, branchName = _a.branchName;
@@ -92,6 +95,11 @@ var BumpVersionTxtTask = /** @class */ (function () {
             });
         });
     };
+    BumpVersionTxtTask.prototype.skip = function (projectId) {
+        // These projects need to be bumped after master merge back to dev. So we skip them here.
+        var skipProjectIds = [constants_1.PROJECT_NAMES.backend.clients, constants_1.PROJECT_NAMES.backend.goodstuff];
+        return (skipProjectIds.some(function (id) { return id === projectId.toString(); }));
+    };
     BumpVersionTxtTask = __decorate([
         (0, inversify_1.injectable)(),
         __param(0, (0, inversify_1.inject)(types_1.SERVICES.GitLabService)),

package/lib/src/tasks/CreateReleaseNotesTask.js

@@ -74,7 +74,6 @@ var CreateReleaseNotesTask = /** @class */ (function () {
                     case 1:
                         projects = _a.sent();
                         combinedDescription = '';
-                        utils_1.Logger.logMessage('Created files');
                         _i = 0, projects_1 = projects;
                         _a.label = 2;
                     case 2:
@@ -94,7 +93,6 @@ var CreateReleaseNotesTask = /** @class */ (function () {
                         return [4 /*yield*/, fs_extra_1.default.outputFile(path_1.default.resolve(outputPath_1), description)];
                     case 3:
                         _a.sent();
-                        utils_1.Logger.logInfo('- ' + outputPath_1);
                         _a.label = 4;
                     case 4:
                         _i++;
@@ -104,7 +102,8 @@ var CreateReleaseNotesTask = /** @class */ (function () {
                         return [4 /*yield*/, fs_extra_1.default.outputFile(path_1.default.resolve(outputPath), combinedDescription)];
                     case 6:
                         _a.sent();
-                        utils_1.Logger.logInfo('- ' + outputPath);
+                        utils_1.Logger.logMessage('Created file');
+                        utils_1.Logger.logInfo("".concat(path_1.default.resolve(outputPath), "\n"));
                         return [2 /*return*/, true];
                 }
             });

package/lib/src/tasks/ListProjectsTask.js

@@ -0,0 +1,87 @@
+"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 __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.ListProjectsTask = void 0;
+var lodash_1 = __importDefault(require("lodash"));
+require("reflect-metadata");
+var inversify_1 = require("inversify");
+var utils_1 = require("../utils");
+var constants_1 = require("../constants");
+var ListProjectsTask = /** @class */ (function () {
+    function ListProjectsTask() {
+    }
+    ListProjectsTask.prototype.run = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                utils_1.Logger.logTask('Listing projects');
+                this.logAvailableProjects(constants_1.PROJECT_NAMES);
+                utils_1.Logger.logSuccess("Available project names are listed above to be used for -p arg\n");
+                return [2 /*return*/, true];
+            });
+        });
+    };
+    ListProjectsTask.prototype.logAvailableProjects = function (projectNames) {
+        for (var _i = 0, _a = Object.keys(projectNames); _i < _a.length; _i++) {
+            var key = _a[_i];
+            var groupTitle = "".concat(lodash_1.default.capitalize(key), " project names:");
+            this.logProjectsByGroup(groupTitle, projectNames[key]);
+        }
+    };
+    ListProjectsTask.prototype.logProjectsByGroup = function (groupName, projectInfo) {
+        utils_1.Logger.logMessage(groupName);
+        for (var _i = 0, _a = Object.keys(projectInfo); _i < _a.length; _i++) {
+            var key = _a[_i];
+            utils_1.Logger.logInfo(key);
+        }
+        utils_1.Logger.logInfo('');
+    };
+    ListProjectsTask = __decorate([
+        (0, inversify_1.injectable)()
+    ], ListProjectsTask);
+    return ListProjectsTask;
+}());
+exports.ListProjectsTask = ListProjectsTask;

package/lib/src/tasks/index.js

@@ -24,6 +24,7 @@ __exportStar(require("./InstallPackagesTask"), exports);
 __exportStar(require("./StartConsumingProjectBuildsTask"), exports);
 __exportStar(require("./StartMonorepoBuildTask"), exports);
 __exportStar(require("./TagMasterTask"), exports);
+__exportStar(require("./ListProjectsTask"), exports);
 __exportStar(require("./ValidateCommitsTask"), exports);
 __exportStar(require("./ValidateDescriptionsTask"), exports);
 __exportStar(require("./ValidateMergeRequestTask"), exports);

package/lib/src/types.js

@@ -28,7 +28,8 @@ exports.TASKS = {
     ValidateMergeRequestTask: Symbol.for('ValidateMergeRequestTask'),
     StartMonorepoBuildTask: Symbol.for('StartMonorepoBuildTask'),
     StartConsumingProjectBuildsTask: Symbol.for('StartConsumingProjectBuildsTask'),
-    TagMasterTask: Symbol.for('TagMasterTask')
+    TagMasterTask: Symbol.for('TagMasterTask'),
+    ListProjectsTask: Symbol.for('ListProjectsTask')
 };
 exports.COMMANDS = {
     StatusCommand: Symbol.for('StatusCommand'),
@@ -41,5 +42,6 @@ exports.COMMANDS = {
     BumpPackagesCommand: Symbol.for('BumpPackagesCommand'),
     ValidateMergeRequestCommand: Symbol.for('ValidateMergeRequestCommand'),
     StartConsumingProjectBuildsCommand: Symbol.for('StartConsumingProjectBuildsCommand'),
-    TagMasterCommand: Symbol.for('TagMasterCommand')
+    TagMasterCommand: Symbol.for('TagMasterCommand'),
+    ListProjectsCommand: Symbol.for('ListProjectsCommand')
 };

package/package.json

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