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

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)];
                 }
             });
@@ -158,8 +156,7 @@ var GitLabApiClient = /** @class */ (function () {
                             name: release.name,
                             tag_name: release.tag,
                             description: release.description,
-                            ref: release.ref,
-                            milestones: release.milestones
+                            ref: release.ref
                         })];
                     case 1:
                         newRelease = _a.sent();

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) {
@@ -36,7 +37,8 @@ exports.GitLabMapper = {
         return {
             id: c.id,
             title: c.title,
-            message: c.message
+            message: c.message,
+            parentIds: c.parent_ids
         };
     },
     branch: function (b) {

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/services/GitLabService.js

@@ -412,7 +412,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 +426,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/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/Commits.js

@@ -14,9 +14,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Commits = void 0;
 exports.Commits = {
     /**
-     * Returns true if dev contains commits that are not merge requests being merged in.
+     * Returns true if dev contains commits that are merge commits from a milestone
+     * that is beyond the current release milestone
      */
     shouldCherryPick: function (project, commits) {
+        var _a;
         var commitKeys = project.mergeRequests.reduce(function (prev, current) {
             var _a;
             if (!current.mergeCommit)
@@ -25,8 +27,16 @@ exports.Commits = {
         }, {});
         for (var _i = 0, commits_1 = commits; _i < commits_1.length; _i++) {
             var commit = commits_1[_i];
-            if (!commitKeys[commit.id])
+            if (!commitKeys[commit.id]) {
+                /**
+                 * Commits straight to dev will have 1 parentId, however
+                 * merge commits that are potentially targeting another milestone
+                 * will have at least 2 parent Ids.
+                 */
+                if (((_a = commit.parentIds) === null || _a === void 0 ? void 0 : _a.length) === 1)
+                    continue;
                 return true;
+            }
         }
         return false;
     }

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/package.json

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