@clickview/ship-it 0.0.6-rc.2 → 0.0.7-rc.0

package/README.md

@@ -20,13 +20,20 @@ After installation, you can run `npm run start -- help` for a list of Shit Comma
 
 The available commands are listed below. If you run into issues check that you have met all the [prerequisites](#prerequisites) first.
 
+Note down the numeric project id from your project's homepage on GitLab - this will be useful for running some of the commands below.
+
 ### Status
 
-* Command: `npm run start -- status -p [projectId] -m [milestone]`
-* Example: `npm run start -- status -p 887 -m T3`
+* Command: `npm run start -- status -m milestone [-p projectId]`
+* Example: `npm run start -- status -m T3 -p 887`
+
+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.
 
-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.
+### Create Notes
 
-You can find your numeric project id from your project page on GitLab.
+* Command: `npm run start -- create-notes -m milestone [-p projectId]`
+* Example: `npm run start -- create-notes -m U3 -p 887`
 
+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.
 
+The notes will be saved in a `dist` folder in markdown format.

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

@@ -109,8 +109,6 @@ var GitLabApiClient = /** @class */ (function () {
                     case 0: return [4 /*yield*/, this.client.Tags.all(projectId, { maxPages: 1, perPage: 20 })];
                     case 1:
                         tags = _a.sent();
-                        if (!tags.length)
-                            throw new errors_1.ShipItError("Project ".concat(projectId, " does not have any tags"));
                         return [2 /*return*/, tags.map(GitLabMapper_1.GitLabMapper.tag)];
                 }
             });

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

@@ -23,7 +23,8 @@ exports.GitLabMapper = {
     project: function (p) {
         return {
             id: p.id,
-            title: p.name
+            title: p.name,
+            url: p.web_url
         };
     },
     tag: function (t) {

package/lib/src/commands/StatusCommand.js

@@ -60,22 +60,18 @@ var StatusCommand = /** @class */ (function () {
     }
     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:
-                        cont = _a.sent();
-                        // Check if we want to continue with inquirer?
-                        if (!cont)
-                            return [2 /*return*/, false];
+                        _a.sent();
                         return [4 /*yield*/, this.validateDescriptionsTask.run(options)];
                     case 2:
-                        cont = _a.sent();
-                        if (!cont)
-                            return [2 /*return*/, false];
+                        _a.sent();
                         return [4 /*yield*/, this.validateCommitsTask.run(options)];
-                    case 3: return [2 /*return*/, _a.sent()];
+                    case 3:
+                        _a.sent();
+                        return [2 /*return*/, true];
                 }
             });
         });

package/lib/src/constants/ProjectNames.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PROJECT_NAMES = void 0;
+exports.PROJECT_NAMES = {
+    frontend: {
+        monorepo: '798',
+        online: '109',
+        curator: '62',
+        lite: '822',
+        // Project names listed below are projects that have multiple names internally. Either can be used as an argument
+        cloud: '534',
+        le: '534',
+        analytics: '970',
+        reports: '970'
+    },
+    /**
+     * IMPORTANT: Please don't append "api" or "service" to these names unless it makes sense (like for tvweb vs tvapi)
+     * If someone passes for example "emailservice" or "onlineapi" as arguments,
+     * it will still be detected by `ProjectIds.ts`
+     */
+    backend: {
+        integrations: '850',
+        auth: '54',
+        online: '41',
+        email: '66',
+        launch: '969',
+        videoprocessor: '84',
+        image: '83',
+        hydration: '844',
+        index: '932',
+        search: '936',
+        videoviews: '835',
+        domain: '108',
+        classroom: '921',
+        classrooms: '921',
+        user: '914',
+        users: '914',
+        tvweb: '161',
+        cloud247web: '161',
+    },
+    mobile: {
+        android: '887'
+    }
+};

package/lib/src/constants/TeamCityBuildIDs.js

@@ -2,12 +2,12 @@
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TeamCityBuildIds = void 0;
-var utils_1 = require("../utils");
+var constants_1 = require("../constants");
 exports.TeamCityBuildIds = (_a = {},
-    _a[utils_1.PROJECT_NAMES.monorepo] = 'Frontend_BuildAndPublishReleaseCandidate',
-    _a[utils_1.PROJECT_NAMES.online] = 'online_web_build_and_package',
-    _a[utils_1.PROJECT_NAMES.curator] = 'curator_web_build_and_package',
-    _a[utils_1.PROJECT_NAMES.cloud] = 'ClickViewCloud_BuildAndPackageDocker',
-    _a[utils_1.PROJECT_NAMES.reports] = 'Web_AnalyticsWeb_BuildAndPackageDocker',
-    _a[utils_1.PROJECT_NAMES.lite] = 'ClickViewLiteWeb_BuildAndPackageDocker',
+    _a[constants_1.PROJECT_NAMES.frontend.monorepo] = 'Frontend_BuildAndPublishReleaseCandidate',
+    _a[constants_1.PROJECT_NAMES.frontend.online] = 'online_web_build_and_package',
+    _a[constants_1.PROJECT_NAMES.frontend.curator] = 'curator_web_build_and_package',
+    _a[constants_1.PROJECT_NAMES.frontend.cloud] = 'ClickViewCloud_BuildAndPackageDocker',
+    _a[constants_1.PROJECT_NAMES.frontend.reports] = 'Web_AnalyticsWeb_BuildAndPackageDocker',
+    _a[constants_1.PROJECT_NAMES.frontend.lite] = 'ClickViewLiteWeb_BuildAndPackageDocker',
     _a);

package/lib/src/constants/index.js

@@ -16,3 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./CommandTypeMapping"), exports);
 __exportStar(require("./MonorepoPackageJsonFiles"), exports);
+__exportStar(require("./ProjectNames"), exports);

package/lib/src/services/GitLabService.js

@@ -82,37 +82,37 @@ var GitLabService = /** @class */ (function () {
         this.apiClient = apiClient;
     }
     GitLabService.prototype.getProjects = function (options) {
-        var _a;
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function () {
             var allMergeRequests, mergeRequests, projectIds, projects, mappedProjects, _i, mappedProjects_1, mappedProject, extraProjects;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
+            return __generator(this, function (_c) {
+                switch (_c.label) {
                     case 0:
                         if (this.projects)
                             return [2 /*return*/, this.projects];
                         return [4 /*yield*/, this.apiClient.getMergeRequests(options)];
                     case 1:
-                        allMergeRequests = _b.sent();
+                        allMergeRequests = _c.sent();
                         mergeRequests = allMergeRequests.filter(function (mr) { return mr.targetBranch !== 'master'; });
                         if (!(mergeRequests === null || mergeRequests === void 0 ? void 0 : mergeRequests.length))
                             throw new errors_1.ShipItError('Could not find any merge requests for the specified options');
                         projectIds = lodash_1.default.uniqBy(mergeRequests, function (m) { return m.projectId; }).map(function (m) { return m.projectId; });
                         return [4 /*yield*/, this.apiClient.getProjectsByIds(projectIds)];
                     case 2:
-                        projects = _b.sent();
+                        projects = _c.sent();
                         if (!(projects === null || projects === void 0 ? void 0 : projects.length) || projects.length !== projectIds.length)
                             throw new errors_1.ShipItError('Could not find all projects for the found merge requests');
                         mappedProjects = projects.map(function (p) { return (__assign(__assign({}, p), { mergeRequests: mergeRequests.filter(function (mr) { return mr.projectId === p.id; }) })); });
                         _i = 0, mappedProjects_1 = mappedProjects;
-                        _b.label = 3;
+                        _c.label = 3;
                     case 3:
                         if (!(_i < mappedProjects_1.length)) return [3 /*break*/, 6];
                         mappedProject = mappedProjects_1[_i];
                         return [4 /*yield*/, this.getExtraProjects(mappedProject, projectIds)];
                     case 4:
-                        extraProjects = _b.sent();
+                        extraProjects = _c.sent();
                         Array.prototype.push.apply(mappedProjects, extraProjects.map(function (p) { return (__assign(__assign({}, p), { mergeRequests: [] })); }));
-                        _b.label = 5;
+                        _c.label = 5;
                     case 5:
                         _i++;
                         return [3 /*break*/, 3];
@@ -126,6 +126,12 @@ var GitLabService = /** @class */ (function () {
                                 return (_a = options.projectIds) === null || _a === void 0 ? void 0 : _a.some(function (pid) { return p.id.toString() === pid; });
                             });
                         }
+                        if ((_b = options.omittedProjectIds) === null || _b === void 0 ? void 0 : _b.length) {
+                            mappedProjects = mappedProjects.filter(function (p) {
+                                var _a;
+                                return !((_a = options.omittedProjectIds) === null || _a === void 0 ? void 0 : _a.some(function (pid) { return p.id.toString() === pid; }));
+                            });
+                        }
                         return [2 /*return*/, (this.projects = mappedProjects)];
                 }
             });
@@ -412,7 +418,7 @@ var GitLabService = /** @class */ (function () {
                     case 1:
                         tags = _a.sent();
                         if (!(tags === null || tags === void 0 ? void 0 : tags.length))
-                            return [2 /*return*/, null];
+                            throw new errors_1.ShipItError("Project ".concat(projectId, " does not have any tags"));
                         tagNames = tags.map(function (t) { return t.name; }).filter(function (t) { return semver_1.default.valid(t); });
                         if (!tagNames.length)
                             return [2 /*return*/, null];
@@ -426,6 +432,19 @@ var GitLabService = /** @class */ (function () {
             });
         });
     };
+    GitLabService.prototype.hasSomeTags = function (projectId) {
+        return __awaiter(this, void 0, void 0, function () {
+            var tags;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.apiClient.getLatestTags(projectId)];
+                    case 1:
+                        tags = _a.sent();
+                        return [2 /*return*/, !!(tags === null || tags === void 0 ? void 0 : tags.length)];
+                }
+            });
+        });
+    };
     GitLabService.prototype.getNextBranchInfo = function (projectId, version) {
         return __awaiter(this, void 0, void 0, function () {
             var tag, nextVersion, branchName, branch;

package/lib/src/startup/AddMilestoneCommand.js

@@ -50,9 +50,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.processMilestoneCommandOptions = exports.getAddMilestoneCommand = void 0;
 var utils_1 = require("../utils");
 function processOptions(options) {
+    var _a, _b;
     var opts = __assign(__assign({}, options), { version: 'minor' });
+    if (((_a = options.projectIds) === null || _a === void 0 ? void 0 : _a.length) && ((_b = options.omit) === null || _b === void 0 ? void 0 : _b.length))
+        throw new Error("Cannot provide both project IDs and omitted project IDs in the same command");
     if (options.projectIds)
         opts.projectIds = utils_1.ProjectIds.getProjectIds(options.projectIds);
+    if (options.omit)
+        opts.omittedProjectIds = utils_1.ProjectIds.getProjectIds(options.omit);
     if (options.hotfix && options.major)
         throw new Error('Cannot pass both --hotfix and --major options');
     if (options.major)
@@ -69,6 +74,7 @@ var getAddMilestoneCommand = function (program, getAction) {
             .description(description)
             .requiredOption('-m, --milestone <milestone>')
             .option('-p, --projectIds <projectIds...>')
+            .option('-o, --omit <omittedProjectIds...>')
             .option('--hotfix')
             .option('--major')
             .action(function (opts) { return __awaiter(_this, void 0, void 0, function () {

package/lib/src/startup/SetupCommands.js

@@ -54,6 +54,7 @@ function setupCommands(program, container) {
         .description('Create releases for all projects that are part of a milestone')
         .requiredOption('-m, --milestone <milestone>')
         .option('-p, --projectIds <projectIds...>')
+        .option('-o, --omit <omittedProjectIds...>')
         .option('--hotfix')
         .option('--major')
         .option('--trigger-monorepo-build')
@@ -80,6 +81,7 @@ function setupCommands(program, container) {
         .option('-m, --milestone <milestone>')
         .option('-b, --monorepoBranchName <monorepoBranchName>')
         .option('-p, --projectIds <projectIds...>')
+        .option('-o, --omit <omittedProjectIds...>')
         .action(function (opts) { return __awaiter(_this, void 0, void 0, function () {
         var options;
         return __generator(this, function (_a) {
@@ -103,6 +105,7 @@ function setupCommands(program, container) {
         .option('-m, --milestone <milestone>')
         .option('--monorepoBranchName <monorepoBranchName>')
         .option('-p, --projectIds <projectIds...>')
+        .option('-o, --omit <omittedProjectIds...>')
         .action(function (opts) { return __awaiter(_this, void 0, void 0, function () {
         var options;
         return __generator(this, function (_a) {

package/lib/src/tasks/InstallPackagesTask.js

@@ -102,6 +102,7 @@ var InstallPackagesTask = /** @class */ (function () {
                         options = {
                             version: _options.version,
                             projectIds: _options.projectIds,
+                            omittedProjectIds: _options.omittedProjectIds,
                             milestone: milestone
                         };
                         return [4 /*yield*/, this.service.getProjects(options)];

package/lib/src/tasks/StartConsumingProjectBuildsTask.js

@@ -85,6 +85,7 @@ var StartConsumingProjectBuildsTask = /** @class */ (function () {
                         options = {
                             version: _options.version,
                             projectIds: _options.projectIds,
+                            omittedProjectIds: _options.omittedProjectIds,
                             milestone: milestone
                         };
                         return [4 /*yield*/, this.gitLabService.getProjects(options)];

package/lib/src/tasks/ValidateTask.js

@@ -86,18 +86,20 @@ 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, count, ready, wrongTargetMrs, message;
+                            var hasSomeTags, groupedMRs, count, ready, wrongTargetMrs, message_1, issues;
                             return __generator(this, function (_b) {
                                 switch (_b.label) {
-                                    case 0:
+                                    case 0: return [4 /*yield*/, this_1.service.hasSomeTags(project.id)];
+                                    case 1:
+                                        hasSomeTags = _b.sent();
                                         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;
+                                        ready = !count.opened || count.opened === 0 && hasSomeTags;
                                         return [4 /*yield*/, this_1.getMRsTargetingWrongBranch(project, options.version)];
-                                    case 1:
+                                    case 2:
                                         wrongTargetMrs = _b.sent();
                                         if (wrongTargetMrs.length)
                                             ready = false;
@@ -107,12 +109,18 @@ var ValidateTask = /** @class */ (function () {
                                             utils_1.Logger.logSuccess("[".concat(project.title, "] READY"));
                                         }
                                         else {
-                                            message = "[".concat(project.title, "] NOT READY");
+                                            message_1 = "[".concat(project.title, "] NOT READY:");
+                                            issues = [];
                                             if (count.opened)
-                                                message += " Contains ".concat(count.opened, " Open MR(s)");
+                                                issues.push("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);
+                                                issues.push("Contains ".concat(wrongTargetMrs.length, " MR(s) not targeting dev or release branch"));
+                                            if (!hasSomeTags)
+                                                issues.push("Does not have any tags. Please create one here: ".concat(project.url, "/tags"));
+                                            issues.forEach(function (issue) {
+                                                message_1 += "\n- ".concat(issue);
+                                            });
+                                            utils_1.Logger.logError(message_1);
                                         }
                                         return [2 /*return*/];
                                 }

package/lib/src/utils/Descriptions.js

@@ -1,4 +1,13 @@
 "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 = {
@@ -28,6 +37,31 @@ var VALID_MONOREPO_HEADINGS = {
     'monorepo': true,
     'before release': true
 };
+/**
+ * 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 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'
+];
 function toObject(lines, headingPrefix) {
     var obj = {};
     var currentHeading = 'other';
@@ -56,6 +90,18 @@ function toObject(lines, headingPrefix) {
     }
     return obj;
 }
+/**
+ * I can't read this code but it came from here and it works: https://stackoverflow.com/a/63457487/14258157
+ * - Josh
+ */
+function orderDescriptionHeadings(headings) {
+    var orderForIndexVals = __spreadArray([], HEADING_ORDER, true).reverse();
+    return headings.sort(function (a, b) {
+        var aIndex = -orderForIndexVals.indexOf(a);
+        var bIndex = -orderForIndexVals.indexOf(b);
+        return aIndex - bIndex;
+    });
+}
 exports.Descriptions = {
     isDescriptionValid: function (description, headingPrefix, checkForTesting) {
         if (headingPrefix === void 0) { headingPrefix = '#'; }
@@ -109,7 +155,8 @@ exports.Descriptions = {
             _loop_1(descriptionObj);
         }
         var description = '';
-        Object.keys(obj).forEach(function (key) {
+        var orderedHeadings = orderDescriptionHeadings(Object.keys(obj));
+        orderedHeadings.forEach(function (key) {
             if (key === 'notes')
                 return;
             if (!obj[key])
@@ -131,7 +178,8 @@ exports.Descriptions = {
                 if (!combinedObj[key])
                     combinedObj[key] = {};
                 var combinedSubObj = toObject(descriptionObj[key].split('\n'), '##');
-                Object.keys(combinedSubObj).forEach(function (subKey) {
+                var orderedHeadings = orderDescriptionHeadings(Object.keys(combinedSubObj));
+                orderedHeadings.forEach(function (subKey) {
                     if (!combinedObj[key][subKey])
                         combinedObj[key][subKey] = '';
                     combinedObj[key][subKey] += combinedSubObj[subKey];
@@ -143,9 +191,10 @@ exports.Descriptions = {
             var descriptionObj = descriptionObjs_2[_i];
             _loop_2(descriptionObj);
         }
+        var orderedHeadings = orderDescriptionHeadings(Object.keys(combinedObj));
         // Build our description
         var description = '';
-        Object.keys(combinedObj).forEach(function (key) {
+        orderedHeadings.forEach(function (key) {
             if (key === 'notes')
                 return;
             description += '\n# ' + key.charAt(0).toUpperCase() + key.slice(1) + '\n';

package/lib/src/utils/ProjectIds.js

@@ -1,20 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProjectIds = exports.PROJECT_NAMES = void 0;
+exports.ProjectIds = void 0;
+var lodash_1 = require("lodash");
+var constants_1 = require("../constants");
 var errors_1 = require("../errors");
-exports.PROJECT_NAMES = {
-    monorepo: '798',
-    online: '109',
-    curator: '62',
-    cloud: '534',
-    reports: '970',
-    lite: '822',
-    android: '887',
-    integrationsapi: '850',
-    auth: '54'
-};
 exports.ProjectIds = {
-    MONOREPO_PROJECT_ID: '798',
+    MONOREPO_PROJECT_ID: constants_1.PROJECT_NAMES.frontend.monorepo,
     /**
      * This allows project names to be passed into the CLI.
      * For example `ship-it release -m S2 -p lite`
@@ -27,11 +18,30 @@ exports.ProjectIds = {
                 projectIds.push(project);
                 continue;
             }
-            var mappedId = exports.PROJECT_NAMES[project.toLowerCase()];
+            var mappedId = getMappedId(project);
             if (!mappedId)
                 throw new errors_1.ShipItError("Could not find project id mapping for ".concat(project));
             projectIds.push(mappedId);
         }
-        return projectIds;
+        return (0, lodash_1.uniq)(projectIds);
     }
 };
+function getMappedId(project) {
+    for (var projectGroup in constants_1.PROJECT_NAMES) {
+        var projectGroupIds = constants_1.PROJECT_NAMES[projectGroup];
+        if (projectGroupIds[project])
+            return projectGroupIds[project];
+        // Support arguments such as "emailapi"
+        if (projectGroupIds[project.replace('api', '')])
+            return projectGroupIds[project.replace('api', '')];
+        // Support arguments such as "emailservice"
+        if (projectGroupIds[project.replace('service', '')])
+            return projectGroupIds[project.replace('service', '')];
+        // Support arguments such as "launchweb"
+        if (projectGroupIds[project.replace('web', '')])
+            return projectGroupIds[project.replace('web', '')];
+        // Support arguments such as "hydrationapp"
+        if (projectGroupIds[project.replace('app', '')])
+            return projectGroupIds[project.replace('app', '')];
+    }
+}

package/package.json

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