@clickview/ship-it 0.0.10 → 0.0.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. package/dist/X2/Analytics Web.md +11 -0
  2. package/dist/X2/Batch.Api.md +11 -0
  3. package/dist/X2/ClickView Online.md +43 -0
  4. package/dist/X2/ClickView.Cloud247.SpliceService.md +12 -0
  5. package/dist/X2/ClickView.Cron.md +10 -0
  6. package/dist/X2/ClickView.Curator.md +22 -0
  7. package/dist/X2/ClickView.OnlineApi.md +14 -0
  8. package/dist/X2/Curriculum.App.md +9 -0
  9. package/dist/X2/CurriculumIngestion.Api.md +8 -0
  10. package/dist/X2/Discover.Api.md +35 -0
  11. package/dist/X2/Domain.Api.md +11 -0
  12. package/dist/X2/FileGenerator.md +11 -0
  13. package/dist/X2/Hydration.App.md +9 -0
  14. package/dist/X2/Integrations.Api.md +8 -0
  15. package/dist/X2/Krakend.md +18 -0
  16. package/dist/X2/LTI.md +11 -0
  17. package/dist/X2/Library Editor.md +11 -0
  18. package/dist/X2/Library.Api.md +13 -0
  19. package/dist/X2/Lite.md +21 -0
  20. package/dist/X2/Master.Api.md +21 -0
  21. package/dist/X2/Master.Auth.md +22 -0
  22. package/dist/X2/Objects.Api.md +30 -0
  23. package/dist/X2/Permissions.Api.md +34 -0
  24. package/dist/X2/Release Notes.md +932 -0
  25. package/dist/X2/Share.Api.md +8 -0
  26. package/dist/X2/Subjects.API.md +21 -0
  27. package/dist/X2/TvProgramMonitor.App.md +8 -0
  28. package/dist/X2/Users.Api.md +25 -0
  29. package/dist/X2/VideoProcessorService.md +12 -0
  30. package/dist/X2/X2 Release Notes.md +932 -0
  31. package/dist/X2/X2 Testing Notes.csv +1200 -0
  32. package/dist/X2/X2 Testing Notes_old.csv +2060 -0
  33. package/dist/X2/clickview.md +314 -0
  34. package/dist/X2/index.app.md +8 -0
  35. package/dist/X2/notification-service.md +48 -0
  36. package/dist/Y2/Y2 Testing Notes.csv +1057 -0
  37. package/lib/src/commands/CreateTestingNotesCommand.js +84 -0
  38. package/lib/src/commands/index.js +1 -0
  39. package/lib/src/constants/CommandTypeMapping.js +1 -0
  40. package/lib/src/interfaces/models/ProjectConfig.js +9 -0
  41. package/lib/src/inversify.config.js +2 -0
  42. package/lib/src/services/GitLabService.js +33 -0
  43. package/lib/src/startup/SetupCommands.js +1 -0
  44. package/lib/src/tasks/CreateMergeRequestTask.js +12 -9
  45. package/lib/src/tasks/CreateReleaseNotesTask.js +11 -8
  46. package/lib/src/tasks/CreateTestingNotesTask.js +135 -0
  47. package/lib/src/tasks/ValidateDescriptionsTask.js +63 -33
  48. package/lib/src/tasks/ValidateMergeRequestTask.js +5 -4
  49. package/lib/src/tasks/index.js +1 -0
  50. package/lib/src/types.js +2 -0
  51. package/lib/src/utils/Csv.js +54 -0
  52. package/lib/src/utils/Descriptions.js +120 -103
  53. package/package.json +3 -2
@@ -0,0 +1,84 @@
1
+ "use strict";
2
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
3
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
4
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
5
+ 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;
6
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
7
+ };
8
+ var __metadata = (this && this.__metadata) || function (k, v) {
9
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
10
+ };
11
+ var __param = (this && this.__param) || function (paramIndex, decorator) {
12
+ return function (target, key) { decorator(target, key, paramIndex); }
13
+ };
14
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
15
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
16
+ return new (P || (P = Promise))(function (resolve, reject) {
17
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
18
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
19
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
20
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
21
+ });
22
+ };
23
+ var __generator = (this && this.__generator) || function (thisArg, body) {
24
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
25
+ return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
26
+ function verb(n) { return function (v) { return step([n, v]); }; }
27
+ function step(op) {
28
+ if (f) throw new TypeError("Generator is already executing.");
29
+ while (_) try {
30
+ 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;
31
+ if (y = 0, t) op = [op[0] & 2, t.value];
32
+ switch (op[0]) {
33
+ case 0: case 1: t = op; break;
34
+ case 4: _.label++; return { value: op[1], done: false };
35
+ case 5: _.label++; y = op[1]; op = [0]; continue;
36
+ case 7: op = _.ops.pop(); _.trys.pop(); continue;
37
+ default:
38
+ if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
39
+ if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
40
+ if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
41
+ if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
42
+ if (t[2]) _.ops.pop();
43
+ _.trys.pop(); continue;
44
+ }
45
+ op = body.call(thisArg, _);
46
+ } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
47
+ if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
48
+ }
49
+ };
50
+ Object.defineProperty(exports, "__esModule", { value: true });
51
+ exports.CreateTestingNotesCommand = void 0;
52
+ require("reflect-metadata");
53
+ var inversify_1 = require("inversify");
54
+ var types_1 = require("../types");
55
+ var CreateTestingNotesCommand = /** @class */ (function () {
56
+ function CreateTestingNotesCommand(validateDescriptionsTask, createTestingNotesTask) {
57
+ this.validateDescriptionsTask = validateDescriptionsTask;
58
+ this.createTestingNotesTask = createTestingNotesTask;
59
+ }
60
+ CreateTestingNotesCommand.prototype.run = function (options) {
61
+ return __awaiter(this, void 0, void 0, function () {
62
+ var cont;
63
+ return __generator(this, function (_a) {
64
+ switch (_a.label) {
65
+ case 0: return [4 /*yield*/, this.validateDescriptionsTask.run(options)];
66
+ case 1:
67
+ cont = _a.sent();
68
+ if (!cont)
69
+ return [2 /*return*/, false];
70
+ return [4 /*yield*/, this.createTestingNotesTask.run(options)];
71
+ case 2: return [2 /*return*/, _a.sent()];
72
+ }
73
+ });
74
+ });
75
+ };
76
+ CreateTestingNotesCommand = __decorate([
77
+ (0, inversify_1.injectable)(),
78
+ __param(0, (0, inversify_1.inject)(types_1.TASKS.ValidateDescriptionsTask)),
79
+ __param(1, (0, inversify_1.inject)(types_1.TASKS.CreateTestingNotesTask)),
80
+ __metadata("design:paramtypes", [Object, Object])
81
+ ], CreateTestingNotesCommand);
82
+ return CreateTestingNotesCommand;
83
+ }());
84
+ exports.CreateTestingNotesCommand = CreateTestingNotesCommand;
@@ -19,6 +19,7 @@ __exportStar(require("./CreateBranchCommand"), exports);
19
19
  __exportStar(require("./CreateMergeRequestCommand"), exports);
20
20
  __exportStar(require("./ListProjectsCommand"), exports);
21
21
  __exportStar(require("./CreateReleaseNotesCommand"), exports);
22
+ __exportStar(require("./CreateTestingNotesCommand"), exports);
22
23
  __exportStar(require("./InstallPackagesCommand"), exports);
23
24
  __exportStar(require("./ReleaseCommand"), exports);
24
25
  __exportStar(require("./StartConsumingProjectBuildsCommand"), exports);
@@ -9,6 +9,7 @@ exports.CommandTypeMapping = {
9
9
  'create-branches': types_1.COMMANDS.CreateBranchCommand,
10
10
  'create-mrs': types_1.COMMANDS.CreateMergeRequestCommand,
11
11
  'create-notes': types_1.COMMANDS.CreateReleaseNotesCommand,
12
+ 'create-testing-notes': types_1.COMMANDS.CreateTestingNotesCommand,
12
13
  'install-packages': types_1.COMMANDS.InstallPackagesCommand,
13
14
  'bump-packages': types_1.COMMANDS.BumpPackagesCommand,
14
15
  'validate-mr': types_1.COMMANDS.ValidateMergeRequestCommand,
@@ -0,0 +1,9 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.DefaultProjectConfig = void 0;
4
+ exports.DefaultProjectConfig = {
5
+ monorepo: {
6
+ enabled: false,
7
+ validSubProjects: []
8
+ }
9
+ };
@@ -35,6 +35,7 @@ function createContainer(config) {
35
35
  container.bind(types_1.TASKS.CreateMergeRequestTask).to(tasks_1.CreateMergeRequestTask);
36
36
  container.bind(types_1.TASKS.ValidateDescriptionsTask).to(tasks_1.ValidateDescriptionsTask);
37
37
  container.bind(types_1.TASKS.CreateReleaseNotesTask).to(tasks_1.CreateReleaseNotesTask);
38
+ container.bind(types_1.TASKS.CreateTestingNotesTask).to(tasks_1.CreateTestingNotesTask);
38
39
  container.bind(types_1.TASKS.InstallPackagesTask).to(tasks_1.InstallPackagesTask);
39
40
  container.bind(types_1.TASKS.BumpPackagesTask).to(tasks_1.BumpPackagesTask);
40
41
  container.bind(types_1.TASKS.CommitPackageVersionsTask).to(tasks_1.CommitPackageVersionsTask);
@@ -53,6 +54,7 @@ function createContainer(config) {
53
54
  container.bind(types_1.COMMANDS.CreateMergeRequestCommand).to(commands_1.CreateMergeRequestCommand);
54
55
  container.bind(types_1.COMMANDS.ReleaseCommand).to(commands_1.ReleaseCommand);
55
56
  container.bind(types_1.COMMANDS.CreateReleaseNotesCommand).to(commands_1.CreateReleaseNotesCommand);
57
+ container.bind(types_1.COMMANDS.CreateTestingNotesCommand).to(commands_1.CreateTestingNotesCommand);
56
58
  container.bind(types_1.COMMANDS.InstallPackagesCommand).to(commands_1.InstallPackagesCommand);
57
59
  container.bind(types_1.COMMANDS.BumpPackagesCommand).to(commands_1.BumpPackagesCommand);
58
60
  container.bind(types_1.COMMANDS.ValidateMergeRequestCommand).to(commands_1.ValidateMergeRequestCommand);
@@ -71,6 +71,7 @@ var types_1 = require("../types");
71
71
  var api_clients_1 = require("../api-clients");
72
72
  var errors_1 = require("../errors");
73
73
  var utils_1 = require("../utils");
74
+ var ProjectConfig_1 = require("../interfaces/models/ProjectConfig");
74
75
  /**
75
76
  * These are projects that will try to use tags to pull in extra projects
76
77
  */
@@ -79,6 +80,7 @@ var MONOREPO_IDS = [
79
80
  ];
80
81
  var GitLabService = /** @class */ (function () {
81
82
  function GitLabService(apiClient) {
83
+ this.projectConfigCache = {};
82
84
  this.apiClient = apiClient;
83
85
  }
84
86
  GitLabService.prototype.getProjects = function (options) {
@@ -473,6 +475,37 @@ var GitLabService = /** @class */ (function () {
473
475
  });
474
476
  });
475
477
  };
478
+ GitLabService.prototype.getProjectConfig = function (projectId, branchName) {
479
+ return __awaiter(this, void 0, void 0, function () {
480
+ var cacheKey, configFileName, configFile, buff, text, json, projectConfig;
481
+ return __generator(this, function (_a) {
482
+ switch (_a.label) {
483
+ case 0:
484
+ cacheKey = projectId + ':' + branchName;
485
+ if (this.projectConfigCache[cacheKey])
486
+ return [2 /*return*/, this.projectConfigCache[cacheKey]];
487
+ configFileName = '.ship-it.config';
488
+ return [4 /*yield*/, this.apiClient.getFile(projectId, configFileName, branchName)];
489
+ case 1:
490
+ configFile = _a.sent();
491
+ if (!configFile)
492
+ return [2 /*return*/, ProjectConfig_1.DefaultProjectConfig];
493
+ try {
494
+ buff = Buffer.from(configFile.content, 'base64');
495
+ text = buff.toString('utf-8');
496
+ json = JSON.parse(text);
497
+ projectConfig = lodash_1.default.merge({}, ProjectConfig_1.DefaultProjectConfig, json);
498
+ this.projectConfigCache[cacheKey] = projectConfig;
499
+ return [2 /*return*/, projectConfig];
500
+ }
501
+ catch (_b) {
502
+ throw new errors_1.ShipItError("Failed to parse ".concat(configFileName));
503
+ }
504
+ return [2 /*return*/];
505
+ }
506
+ });
507
+ });
508
+ };
476
509
  GitLabService = __decorate([
477
510
  (0, inversify_1.injectable)(),
478
511
  __param(0, (0, inversify_1.inject)(types_1.API_CLIENTS.GitLabApiClient)),
@@ -49,6 +49,7 @@ function setupCommands(program, container) {
49
49
  addMilestoneCommand('create-branches', 'Create release branches for all projects that are part of a milestone');
50
50
  addMilestoneCommand('create-mrs', 'Create merge requests for all projects that are part of a milestone');
51
51
  addMilestoneCommand('create-notes', 'Builds descriptions for all projects that are part of a milestone');
52
+ addMilestoneCommand('create-testing-notes', 'Builds testing notes for all projects that are part of a milestone');
52
53
  addMilestoneCommand('tag-master', 'Tags master for all release MRs that are part of a milestone');
53
54
  program.command('release')
54
55
  .description('Create releases for all projects that are part of a milestone')
@@ -60,7 +60,7 @@ var CreateMergeRequestTask = /** @class */ (function () {
60
60
  }
61
61
  CreateMergeRequestTask.prototype.run = function (options) {
62
62
  return __awaiter(this, void 0, void 0, function () {
63
- var projects, _i, projects_1, project, _a, branch, branchName, mergeRequest, description;
63
+ var projects, _i, projects_1, project, _a, branch, branchName, mergeRequest, projectConfig, description;
64
64
  return __generator(this, function (_b) {
65
65
  switch (_b.label) {
66
66
  case 0:
@@ -71,14 +71,14 @@ var CreateMergeRequestTask = /** @class */ (function () {
71
71
  _i = 0, projects_1 = projects;
72
72
  _b.label = 2;
73
73
  case 2:
74
- if (!(_i < projects_1.length)) return [3 /*break*/, 7];
74
+ if (!(_i < projects_1.length)) return [3 /*break*/, 8];
75
75
  project = projects_1[_i];
76
76
  return [4 /*yield*/, this.service.getNextBranchInfo(project.id, options.version)];
77
77
  case 3:
78
78
  _a = _b.sent(), branch = _a.branch, branchName = _a.branchName;
79
79
  if (!branch) {
80
80
  utils_1.Logger.logError("[".concat(project.title, "]: [").concat(branchName, "] does not exist"));
81
- return [3 /*break*/, 6];
81
+ return [3 /*break*/, 7];
82
82
  }
83
83
  return [4 /*yield*/, this.service.getMergeRequest(project.id, branchName, 'opened')];
84
84
  case 4:
@@ -86,21 +86,24 @@ var CreateMergeRequestTask = /** @class */ (function () {
86
86
  if (mergeRequest) {
87
87
  utils_1.Logger.logWarning("[".concat(project.title, "]: MR already exists"));
88
88
  utils_1.Logger.logInfo(mergeRequest.url);
89
- return [3 /*break*/, 6];
89
+ return [3 /*break*/, 7];
90
90
  }
91
- description = project.id.toString() === utils_1.ProjectIds.MONOREPO_PROJECT_ID ?
91
+ return [4 /*yield*/, this.service.getProjectConfig(project.id, 'dev')];
92
+ case 5:
93
+ projectConfig = _b.sent();
94
+ description = projectConfig.monorepo.enabled ?
92
95
  utils_1.Descriptions.getMonorepoCombinedDescription(project.mergeRequests) :
93
96
  utils_1.Descriptions.getCombinedDescription(project.mergeRequests);
94
97
  return [4 /*yield*/, this.service.createMergeRequest(project.id, branchName, description, options.milestone)];
95
- case 5:
98
+ case 6:
96
99
  mergeRequest = _b.sent();
97
100
  utils_1.Logger.logMessage("[".concat(project.title, "]: MR created"));
98
101
  utils_1.Logger.logInfo(mergeRequest.url);
99
- _b.label = 6;
100
- case 6:
102
+ _b.label = 7;
103
+ case 7:
101
104
  _i++;
102
105
  return [3 /*break*/, 2];
103
- case 7: return [2 /*return*/, true];
106
+ case 8: return [2 /*return*/, true];
104
107
  }
105
108
  });
106
109
  });
@@ -65,7 +65,7 @@ var CreateReleaseNotesTask = /** @class */ (function () {
65
65
  }
66
66
  CreateReleaseNotesTask.prototype.run = function (options) {
67
67
  return __awaiter(this, void 0, void 0, function () {
68
- var projects, combinedDescription, _i, projects_1, project, fileName, description, outputPath_1, outputPath;
68
+ var projects, combinedDescription, _i, projects_1, project, fileName, description, projectConfig, outputPath_1, outputPath;
69
69
  return __generator(this, function (_a) {
70
70
  switch (_a.label) {
71
71
  case 0:
@@ -77,11 +77,14 @@ var CreateReleaseNotesTask = /** @class */ (function () {
77
77
  _i = 0, projects_1 = projects;
78
78
  _a.label = 2;
79
79
  case 2:
80
- if (!(_i < projects_1.length)) return [3 /*break*/, 5];
80
+ if (!(_i < projects_1.length)) return [3 /*break*/, 6];
81
81
  project = projects_1[_i];
82
82
  fileName = "".concat(project.title, ".md");
83
83
  description = '';
84
- if (project.id.toString() === utils_1.ProjectIds.MONOREPO_PROJECT_ID) {
84
+ return [4 /*yield*/, this.service.getProjectConfig(project.id, 'dev')];
85
+ case 3:
86
+ projectConfig = _a.sent();
87
+ if (projectConfig.monorepo.enabled) {
85
88
  description = utils_1.Descriptions.getMonorepoCombinedDescription(project.mergeRequests);
86
89
  }
87
90
  else {
@@ -91,16 +94,16 @@ var CreateReleaseNotesTask = /** @class */ (function () {
91
94
  combinedDescription += utils_1.Descriptions.bumpHeadings(description);
92
95
  outputPath_1 = "./dist/".concat(options.milestone, "/").concat(fileName);
93
96
  return [4 /*yield*/, fs_extra_1.default.outputFile(path_1.default.resolve(outputPath_1), description)];
94
- case 3:
95
- _a.sent();
96
- _a.label = 4;
97
97
  case 4:
98
+ _a.sent();
99
+ _a.label = 5;
100
+ case 5:
98
101
  _i++;
99
102
  return [3 /*break*/, 2];
100
- case 5:
103
+ case 6:
101
104
  outputPath = "./dist/".concat(options.milestone, "/Release Notes.md");
102
105
  return [4 /*yield*/, fs_extra_1.default.outputFile(path_1.default.resolve(outputPath), combinedDescription)];
103
- case 6:
106
+ case 7:
104
107
  _a.sent();
105
108
  utils_1.Logger.logMessage('Created file');
106
109
  utils_1.Logger.logInfo("".concat(path_1.default.resolve(outputPath), "\n"));
@@ -0,0 +1,135 @@
1
+ "use strict";
2
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
3
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
4
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
5
+ 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;
6
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
7
+ };
8
+ var __metadata = (this && this.__metadata) || function (k, v) {
9
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
10
+ };
11
+ var __param = (this && this.__param) || function (paramIndex, decorator) {
12
+ return function (target, key) { decorator(target, key, paramIndex); }
13
+ };
14
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
15
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
16
+ return new (P || (P = Promise))(function (resolve, reject) {
17
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
18
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
19
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
20
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
21
+ });
22
+ };
23
+ var __generator = (this && this.__generator) || function (thisArg, body) {
24
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
25
+ return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
26
+ function verb(n) { return function (v) { return step([n, v]); }; }
27
+ function step(op) {
28
+ if (f) throw new TypeError("Generator is already executing.");
29
+ while (_) try {
30
+ 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;
31
+ if (y = 0, t) op = [op[0] & 2, t.value];
32
+ switch (op[0]) {
33
+ case 0: case 1: t = op; break;
34
+ case 4: _.label++; return { value: op[1], done: false };
35
+ case 5: _.label++; y = op[1]; op = [0]; continue;
36
+ case 7: op = _.ops.pop(); _.trys.pop(); continue;
37
+ default:
38
+ if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
39
+ if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
40
+ if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
41
+ if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
42
+ if (t[2]) _.ops.pop();
43
+ _.trys.pop(); continue;
44
+ }
45
+ op = body.call(thisArg, _);
46
+ } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
47
+ if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
48
+ }
49
+ };
50
+ var __importDefault = (this && this.__importDefault) || function (mod) {
51
+ return (mod && mod.__esModule) ? mod : { "default": mod };
52
+ };
53
+ Object.defineProperty(exports, "__esModule", { value: true });
54
+ exports.CreateTestingNotesTask = void 0;
55
+ require("reflect-metadata");
56
+ var inversify_1 = require("inversify");
57
+ var path_1 = __importDefault(require("path"));
58
+ var fs_extra_1 = __importDefault(require("fs-extra"));
59
+ var types_1 = require("../types");
60
+ var services_1 = require("../services");
61
+ var utils_1 = require("../utils");
62
+ var Csv_1 = require("../utils/Csv");
63
+ var CreateTestingNotesTask = /** @class */ (function () {
64
+ function CreateTestingNotesTask(service) {
65
+ this.service = service;
66
+ }
67
+ CreateTestingNotesTask.prototype.run = function (options) {
68
+ return __awaiter(this, void 0, void 0, function () {
69
+ var projects, projectTestingNotes, _i, projects_1, project, description, _a, _b, mr, outputPath, error_1, csv;
70
+ return __generator(this, function (_c) {
71
+ switch (_c.label) {
72
+ case 0:
73
+ utils_1.Logger.logTask('Creating testing notes');
74
+ return [4 /*yield*/, this.service.getProjects(options)];
75
+ case 1:
76
+ projects = _c.sent();
77
+ projectTestingNotes = [];
78
+ for (_i = 0, projects_1 = projects; _i < projects_1.length; _i++) {
79
+ project = projects_1[_i];
80
+ description = '';
81
+ for (_a = 0, _b = project.mergeRequests; _a < _b.length; _a++) {
82
+ mr = _b[_a];
83
+ if (project.id.toString() === utils_1.ProjectIds.MONOREPO_PROJECT_ID) {
84
+ description = utils_1.Descriptions.getMonorepoCombinedDescription([mr]);
85
+ }
86
+ else {
87
+ description = utils_1.Descriptions.getCombinedDescription([mr]);
88
+ }
89
+ projectTestingNotes.push({
90
+ projectName: project.title,
91
+ mrTitle: mr.title,
92
+ mrAuthor: mr.author,
93
+ mrAssignee: mr.assignee,
94
+ mrUrl: mr.url,
95
+ notes: utils_1.Descriptions.bumpHeadings(description).trim()
96
+ });
97
+ }
98
+ }
99
+ outputPath = path_1.default.resolve("./dist/".concat(options.milestone));
100
+ _c.label = 2;
101
+ case 2:
102
+ _c.trys.push([2, 4, , 6]);
103
+ return [4 /*yield*/, fs_extra_1.default.access(outputPath)];
104
+ case 3:
105
+ _c.sent();
106
+ return [3 /*break*/, 6];
107
+ case 4:
108
+ error_1 = _c.sent();
109
+ return [4 /*yield*/, fs_extra_1.default.ensureDir(outputPath)];
110
+ case 5:
111
+ _c.sent();
112
+ return [3 /*break*/, 6];
113
+ case 6:
114
+ csv = new Csv_1.CsvFile({
115
+ headers: ['projectName', 'mrTitle', 'mrAuthor', 'mrAssignee', 'mrUrl', 'notes'],
116
+ path: path_1.default.resolve(outputPath, "".concat(options.milestone, " Testing Notes.csv")),
117
+ });
118
+ return [4 /*yield*/, csv.create(projectTestingNotes)];
119
+ case 7:
120
+ _c.sent();
121
+ utils_1.Logger.logMessage('Created file');
122
+ utils_1.Logger.logInfo("".concat(path_1.default.resolve(outputPath), "\n"));
123
+ return [2 /*return*/, true];
124
+ }
125
+ });
126
+ });
127
+ };
128
+ CreateTestingNotesTask = __decorate([
129
+ (0, inversify_1.injectable)(),
130
+ __param(0, (0, inversify_1.inject)(types_1.SERVICES.GitLabService)),
131
+ __metadata("design:paramtypes", [services_1.GitLabService])
132
+ ], CreateTestingNotesTask);
133
+ return CreateTestingNotesTask;
134
+ }());
135
+ exports.CreateTestingNotesTask = CreateTestingNotesTask;
@@ -65,45 +65,75 @@ var ValidateDescriptionsTask = /** @class */ (function () {
65
65
  ValidateDescriptionsTask.prototype.run = function (options) {
66
66
  var _a;
67
67
  return __awaiter(this, void 0, void 0, function () {
68
- var projects, cont, _i, projects_1, project, invalidMrs, mergeRequestsTargetingDev, _b, mergeRequestsTargetingDev_1, mr, isMonorepo, isMrValid, groupedByUser, key, _c, _d, mr;
69
- return __generator(this, function (_e) {
70
- switch (_e.label) {
68
+ var projects, cont, _loop_1, this_1, _i, projects_1, project;
69
+ return __generator(this, function (_b) {
70
+ switch (_b.label) {
71
71
  case 0:
72
72
  utils_1.Logger.logTask('Validating descriptions');
73
73
  return [4 /*yield*/, this.service.getProjects(options)];
74
74
  case 1:
75
- projects = _e.sent();
75
+ projects = _b.sent();
76
76
  cont = true;
77
- for (_i = 0, projects_1 = projects; _i < projects_1.length; _i++) {
78
- project = projects_1[_i];
79
- invalidMrs = [];
80
- mergeRequestsTargetingDev = project.mergeRequests.filter(function (mergeRequest) {
81
- return mergeRequest.targetBranch === 'dev';
82
- });
83
- for (_b = 0, mergeRequestsTargetingDev_1 = mergeRequestsTargetingDev; _b < mergeRequestsTargetingDev_1.length; _b++) {
84
- mr = mergeRequestsTargetingDev_1[_b];
85
- isMonorepo = project.id.toString() === utils_1.ProjectIds.MONOREPO_PROJECT_ID;
86
- isMrValid = isMonorepo ?
87
- utils_1.Descriptions.isMonorepoDescriptionValid(mr.description) :
88
- utils_1.Descriptions.isDescriptionValid(mr.description);
89
- if (isMonorepo && !((_a = mr.labels) === null || _a === void 0 ? void 0 : _a.length))
90
- isMrValid = false;
91
- if (!isMrValid)
92
- invalidMrs.push(mr);
93
- }
94
- if (invalidMrs.length) {
95
- utils_1.Logger.logError("\n[".concat(project.title, "] has invalid MRs"));
96
- groupedByUser = lodash_1.default.groupBy(invalidMrs, function (mr) { return mr.author; });
97
- for (key in groupedByUser) {
98
- utils_1.Logger.logMessage(key);
99
- for (_c = 0, _d = groupedByUser[key]; _c < _d.length; _c++) {
100
- mr = _d[_c];
101
- utils_1.Logger.logMessage("- ".concat(mr.url));
102
- }
77
+ _loop_1 = function (project) {
78
+ var invalidMrs, targetBranch, mergeRequestsTargetingDev, projectConfig, isMonorepo, _c, mergeRequestsTargetingDev_1, mr, errors, isMrValid, groupedByUser, key, _d, _e, _f, mr, errors, _g, errors_1, error;
79
+ return __generator(this, function (_h) {
80
+ switch (_h.label) {
81
+ case 0:
82
+ invalidMrs = [];
83
+ targetBranch = 'dev';
84
+ mergeRequestsTargetingDev = project.mergeRequests.filter(function (mergeRequest) {
85
+ return mergeRequest.targetBranch === targetBranch;
86
+ });
87
+ return [4 /*yield*/, this_1.service.getProjectConfig(project.id, targetBranch)];
88
+ case 1:
89
+ projectConfig = _h.sent();
90
+ isMonorepo = project.id.toString() === utils_1.ProjectIds.MONOREPO_PROJECT_ID;
91
+ for (_c = 0, mergeRequestsTargetingDev_1 = mergeRequestsTargetingDev; _c < mergeRequestsTargetingDev_1.length; _c++) {
92
+ mr = mergeRequestsTargetingDev_1[_c];
93
+ errors = utils_1.Descriptions.validate(mr.description, projectConfig);
94
+ isMrValid = errors.length === 0;
95
+ if (isMonorepo && !((_a = mr.labels) === null || _a === void 0 ? void 0 : _a.length))
96
+ isMrValid = false;
97
+ if (!isMrValid)
98
+ invalidMrs.push([mr, errors]);
99
+ }
100
+ if (invalidMrs.length) {
101
+ utils_1.Logger.logError("\n[".concat(project.title, "] has invalid MRs"));
102
+ groupedByUser = lodash_1.default.groupBy(invalidMrs, function (_a) {
103
+ var mr = _a[0];
104
+ return mr.author;
105
+ });
106
+ for (key in groupedByUser) {
107
+ utils_1.Logger.logMessage(key);
108
+ for (_d = 0, _e = groupedByUser[key]; _d < _e.length; _d++) {
109
+ _f = _e[_d], mr = _f[0], errors = _f[1];
110
+ utils_1.Logger.logMessage("- ".concat(mr.url));
111
+ for (_g = 0, errors_1 = errors; _g < errors_1.length; _g++) {
112
+ error = errors_1[_g];
113
+ utils_1.Logger.logMessage(" - ".concat(error));
114
+ }
115
+ }
116
+ }
117
+ cont = false;
118
+ }
119
+ return [2 /*return*/];
103
120
  }
104
- cont = false;
105
- }
106
- }
121
+ });
122
+ };
123
+ this_1 = this;
124
+ _i = 0, projects_1 = projects;
125
+ _b.label = 2;
126
+ case 2:
127
+ if (!(_i < projects_1.length)) return [3 /*break*/, 5];
128
+ project = projects_1[_i];
129
+ return [5 /*yield**/, _loop_1(project)];
130
+ case 3:
131
+ _b.sent();
132
+ _b.label = 4;
133
+ case 4:
134
+ _i++;
135
+ return [3 /*break*/, 2];
136
+ case 5:
107
137
  if (cont)
108
138
  utils_1.Logger.logSuccess('All MR descriptions are valid');
109
139
  return [2 /*return*/, cont];
@@ -62,7 +62,7 @@ var ValidateMergeRequestTask = /** @class */ (function () {
62
62
  ValidateMergeRequestTask.prototype.run = function (options) {
63
63
  var _a;
64
64
  return __awaiter(this, void 0, void 0, function () {
65
- var project, mergeRequestId, mergeRequest, isMonorepo, isDescriptionValid;
65
+ var project, mergeRequestId, mergeRequest, isMonorepo, projectConfig, isDescriptionValid;
66
66
  return __generator(this, function (_b) {
67
67
  switch (_b.label) {
68
68
  case 0:
@@ -91,9 +91,10 @@ var ValidateMergeRequestTask = /** @class */ (function () {
91
91
  Logger_1.Logger.logError('Monorepo MRs must have labels');
92
92
  return [2 /*return*/, false];
93
93
  }
94
- isDescriptionValid = isMonorepo ?
95
- utils_1.Descriptions.isMonorepoDescriptionValid(mergeRequest.description) :
96
- utils_1.Descriptions.isDescriptionValid(mergeRequest.description);
94
+ return [4 /*yield*/, this.service.getProjectConfig(project.id, mergeRequest.targetBranch)];
95
+ case 3:
96
+ projectConfig = _b.sent();
97
+ isDescriptionValid = utils_1.Descriptions.validate(mergeRequest.description, projectConfig).length === 0;
97
98
  if (!isDescriptionValid) {
98
99
  Logger_1.Logger.logError('Merge request description is invalid');
99
100
  return [2 /*return*/, false];
@@ -20,6 +20,7 @@ __exportStar(require("./CommitPackageVersionsTask"), exports);
20
20
  __exportStar(require("./CreateBranchTask"), exports);
21
21
  __exportStar(require("./CreateMergeRequestTask"), exports);
22
22
  __exportStar(require("./CreateReleaseNotesTask"), exports);
23
+ __exportStar(require("./CreateTestingNotesTask"), exports);
23
24
  __exportStar(require("./InstallPackagesTask"), exports);
24
25
  __exportStar(require("./StartConsumingProjectBuildsTask"), exports);
25
26
  __exportStar(require("./StartMonorepoBuildTask"), exports);
package/lib/src/types.js CHANGED
@@ -22,6 +22,7 @@ exports.TASKS = {
22
22
  CreateMergeRequestTask: Symbol.for('CreateMergeRequestTask'),
23
23
  ValidateDescriptionsTask: Symbol.for('ValidateDescriptionsTask'),
24
24
  CreateReleaseNotesTask: Symbol.for('CreateReleaseNotesTask'),
25
+ CreateTestingNotesTask: Symbol.for('CreateTestingNotesTask'),
25
26
  InstallPackagesTask: Symbol.for('InstallPackagesTask'),
26
27
  BumpPackagesTask: Symbol.for('BumpPackagesTask'),
27
28
  CommitPackageVersionsTask: Symbol.for('CommitPackageVersionsTask'),
@@ -38,6 +39,7 @@ exports.COMMANDS = {
38
39
  CreateBranchCommand: Symbol.for('CreateBranchCommand'),
39
40
  CreateMergeRequestCommand: Symbol.for('CreateMergeRequestCommand'),
40
41
  CreateReleaseNotesCommand: Symbol.for('CreateReleaseNotesCommand'),
42
+ CreateTestingNotesCommand: Symbol.for('CreateTestingNotesCommand'),
41
43
  InstallPackagesCommand: Symbol.for('InstallPackagesCommand'),
42
44
  BumpPackagesCommand: Symbol.for('BumpPackagesCommand'),
43
45
  ValidateMergeRequestCommand: Symbol.for('ValidateMergeRequestCommand'),