forked from github-tools/github-release-notes
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathgren.js
More file actions
896 lines (802 loc) · 21.9 KB
/
gren.js
File metadata and controls
896 lines (802 loc) · 21.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
'use strict';
var utils = require('./utils');
var githubInfo = require('./github-info');
var Github = require('github-api');
var fs = require('fs');
var chalk = require('chalk');
var Promise = Promise || require('es6-promise').Promise;
var isOnline = require('is-online');
var ObjectAssign = require('object-assign');
var defaults = {
tags: false,
timeWrap: 'latest', // || history
changelogFilename: 'CHANGELOG.md',
dataSource: 'issues', // || commits
draft: false,
force: false,
prefix: '',
includeMessages: 'commits', // || merges || all
prerelease: false,
dateZero: new Date(0),
override: false
};
/**
* Edit arelease from a given tag (in the options)
*
* @since 0.5.0
* @private
*
* @param {GithubReleaseNotes} gren The gren object
* @param {number} releaseId The id of the release to edit
* @param {Object} releaseOptions The options to build the release:
* @example
* {
* "tag_name": "v1.0.0",
* "target_commitish": "master",
* "name": "v1.0.0",
* "body": "Description of the release",
* "draft": false,
* "prerelease": false
* }
*
* @return {Promise}
*/
function editRelease(gren, releaseId, releaseOptions) {
var loaded = utils.task('Updating latest release');
return new Promise(function(resolve, reject) {
gren.repo.updateRelease(releaseId, releaseOptions, function(err, release) {
loaded();
if (err) {
reject(chalk.red(err));
} else {
console.log(chalk.green('\n\n' + release.name + ' has been successfully updated!'));
resolve(true);
}
});
});
}
/**
* Create a release from a given tag (in the options)
*
* @since 0.1.0
* @private
*
* @param {GithubReleaseNotes} gren The gren object
* @param {Object} releaseOptions The options to build the release:
* @example {
* "tag_name": "v1.0.0",
* "target_commitish": "master",
* "name": "v1.0.0",
* "body": "Description of the release",
* "draft": false,
* "prerelease": false
* }
*
* @return {Promise}
*/
function createRelease(gren, releaseOptions) {
var loaded = utils.task('Preparing the release');
return new Promise(function(resolve, reject) {
gren.repo.createRelease(releaseOptions, function(err, release) {
loaded();
if (err) {
var responseText = JSON.parse(err.request.responseText);
console.log(chalk.red(
responseText.message + '\n' +
responseText.errors[0].code
));
reject(false);
} else {
console.log(chalk.green('\n\n' + release.name + ' has been successfully created!'));
resolve(true);
}
});
});
}
/**
* Creates the options to make the release
*
* @since 0.2.0
* @private
*
* @param {GithubReleaseNotes} gren The gren object
* @param {Object[]} tags The collection of tags
*
* @return {Promise}
*/
function prepareRelease(gren, block) {
var releaseOptions = {
tag_name: block.release,
name: gren.options.prefix + block.release,
body: block.body,
draft: gren.options.draft,
prerelease: gren.options.prerelease
};
if (block.id) {
return editRelease(gren, block.id, releaseOptions);
} else {
return createRelease(gren, releaseOptions);
}
}
/**
* Get the tags information from the given ones, and adds
* the next one in case only one is given
*
* @since 0.5.0
* @private
*
* @param {Boolean|Array} selectedTags
* @param {Object[]} tags
*
* @return {Boolean|Array}
*/
function getSelectedTags(optionTags, tags) {
if (!optionTags) {
return false;
}
var selectedTags = [].concat(optionTags);
return tags.filter(function(tag, index) {
var isSelectedTag = selectedTags.indexOf(tag.name) !== -1;
if (isSelectedTag && selectedTags.length === 1 && tags[index + 1]) {
selectedTags.push(tags[index + 1].name);
}
return isSelectedTag;
}).slice(0, 2);
}
/**
* Get all the tags of the repo
*
* @since 0.1.0
* @private
*
* @param {GithubReleaseNotes} gren The gren object
*
* @return {Promise}
*/
function getLastTags(gren, releases) {
var loaded = utils.task('Getting tags');
return new Promise(function(resolve, reject) {
gren.repo.listTags(function(err, tags) {
loaded();
if (err) {
reject(err);
} else {
var filteredTags =
(getSelectedTags(gren.options.tags, tags) || [tags[0], tags[1]])
.map(function(tag) {
var tagRelease = releases && releases.filter(function(release) {
return release.tag_name === tag.name;
})[0] || false;
var releaseId = tagRelease ? tagRelease.id : null;
return {
tag: tag,
releaseId: releaseId
};
});
if (filteredTags[0].releaseId && !gren.options.override) {
reject(chalk.red(filteredTags[0].tag.name + ' is a release, use --override flag to override an existing release!'));
}
console.log('Tags found: ' + filteredTags.map(function (tag) {
return tag.tag.name;
}).join(', '));
resolve(filteredTags);
}
});
});
}
/**
* Get the dates of the last two tags
*
* @since 0.1.0
* @private
*
* @param {GithubReleaseNotes} gren The gren object
* @param {Object[]} tags List of all the tags in the repo
*
* @return {Promise[]} The promises which returns the dates
*/
function getTagDates(gren, tags) {
return tags.map(function(tag) {
return new Promise(function(resolve, reject) {
gren.repo.getCommit(tag.tag.commit.sha, function(err, commit) {
if (err) {
reject(err);
} else {
resolve({
id: tag.releaseId,
name: tag.tag.name,
date: commit.committer.date
});
}
});
});
});
}
/**
* Get all releases
*
* @since 0.5.0
* @private
*
* @param {Object[]} releases A list of release Objects
*
* @return {Array} The list of the dates
*/
function getReleaseDates(gren, releases) {
return [].concat(releases).map(function(release) {
return {
id: release.id,
name: release.name,
tag_name: release.tag_name,
date: release.created_at,
body: release.body || null
};
});
}
/**
* Get all releases
*
* @since 0.5.0
* @private
*
* @param {GithubReleaseNotes} gren The gren object
*
* @return {Promise} The promise which resolves an array of releases
*/
function getListReleases(gren) {
var loaded = utils.task('Getting the list of releases');
return new Promise(function(resolve, reject) {
gren.repo.listReleases(function(err, releases) {
loaded();
if (err && err.request.status !== 404) {
reject(err);
} else {
if (err && err.request.status === 404) {
resolve(false);
} else {
process.stdout.write(releases.length + ' releases found\n');
resolve(releases);
}
}
});
});
}
/**
* Get the latest releases
*
* @since 0.5.0
* @private
*
* @param {GithubReleaseNotes} gren The gren object
*
* @return {Promise} The promise which resolves the tag name of the release
*/
function getLastTwoReleases(gren) {
return getListReleases(gren)
.then(function(releases) {
return releases.slice(0, 2);
});
}
/**
* Return a string with a - to be a bulvar list (used for a mapping)
*
* @since 0.1.0
* @private
*
* @param {string} message
*
* @return {string}
*/
function templateCommits(message) {
return '- ' + message;
}
/**
* Generate the MD template from all the labels of a specific issue
*
* @since 0.5.0
* @private
*
* @param {Object} issue
*
* @return {string}
*/
function templateLabels(issue) {
return issue.labels ? issue.labels.map(function(label) {
return '[**' + label.name + '**] ';
})
.join('') : '[closed]';
}
/**
* Generate the MD template a block
*
* @since 0.5.0
* @private
*
* @param {Object} block ({name: 'v1.2.3', body: []})
*
* @return {string}
*/
function templateBlock(block) {
var date = new Date(block.date);
return '## ' + block.release + ' (' + utils.formatDate(date) + ')' + '\n\n' +
block.body;
}
/**
* Generate the MD template for each issue
*
* @since 0.5.0
* @private
*
* @param {Object} issue
*
* @return {string}
*/
function templateIssue(issue) {
return '- ' + templateLabels(issue) + issue.title + ' [#' + issue.number + '](' + issue.html_url + ')';
}
/**
* Generate the Changelog MD template
*
* @since 0.5.0
* @private
*
* @param {Object[]} blocks
*
* @return {string}
*/
function templateChangelog(blocks) {
return '# Changelog\n\n' +
blocks
.map(templateBlock)
.join('\n\n --- \n\n');
}
/**
* Generate the Changelog issues body template
*
* @since 0.5.0
* @private
*
* @param {Object[]} blocks
*
* @return {string}
*/
function templateIssueBody(body, rangeBody) {
return (body ? body.join('\n') : rangeBody || '*No changelog for this release.*') + '\n';
}
/**
* Return a commit messages generated body
*
* @since 0.1.0
* @private
*
* @param {string} message
*
* @return {string}
*/
function generateCommitsBody(gren, messages) {
return messages
.slice(0, -1)
.filter(function(message) {
var messageType = gren.options.includeMessages;
var filterMap = {
merges: function(message) {
return message.match(/^merge/i);
},
commits: function(message) {
return !message.match(/^merge/i);
},
all: function() {
return true;
}
};
if (filterMap[messageType]) {
return filterMap[messageType](message);
}
return filterMap.commits(message);
})
.map(templateCommits)
.join('\n');
}
/**
* Transforms the commits to commit messages
*
* @since 0.1.0
* @private
*
* @param {Object[]} commits The array of object containing the commits
*
* @return {String[]}
*/
function commitMessages(commits) {
return commits.map(function(commitObject) {
return commitObject.commit.message;
});
}
/**
* Gets all the commits between two dates
*
* @since 0.1.0
* @private
*
* @param {GithubReleaseNotes} gren The gren object
* @param {string} since The since date in ISO
* @param {string} until The until date in ISO
*
* @return {Promise} The promise which resolves the [Array] commit messages
*/
function getCommitsBetweenTwo(gren, since, until) {
process.stdout.write(chalk.green('Get commits between ' + utils.formatDate(new Date(since)) + ' and ' + utils.formatDate(new Date(until)) + '\n'));
var options = {
since: since,
until: until,
per_page: 100
};
return new Promise(function(resolve, reject) {
gren.repo.listCommits(options, function(err, commits) {
if (err) {
reject(err);
} else {
resolve(commitMessages(commits));
}
});
});
}
/**
* Get the blocks of commits based on release dates
*
* @since 0.5.0
* @private
*
* @param {GithubReleaseNotes} gren
* @param {Array} releaseRanges The array of date ranges
*
* @return {Promise[]}
*/
function getCommitBlocks(gren, releaseRanges) {
console.log(chalk.blue('\nCreating the body blocks from commits:'));
return Promise.all(
releaseRanges
.map(function(range) {
return getCommitsBetweenTwo(gren, range[1].date, range[0].date)
.then(function(commits) {
return {
id: range[0].id,
release: range[0].name,
date: range[0].date,
body: generateCommitsBody(gren, commits) + '\n'
};
});
})
);
}
/**
* Get all the closed issues from the current repo
*
* @since 0.5.0
* @private
*
* @param {GithubReleaseNotes} gren The gren object
* @param {Array} releaseRanges The array of date ranges
*
* @return {Promise} The promise which resolves the list of the issues
*/
function getClosedIssues(gren, releaseRanges) {
var loaded = utils.task('Getting all closed issues');
return new Promise(function(resolve, reject) {
gren.issues.listIssues({
state: 'closed',
since: releaseRanges[0][1].date
}, function(err, issues) {
loaded();
if (err) {
reject(err);
} else {
var filteredIssues = issues.filter(function(issue) {
return !issue.pull_request;
});
process.stdout.write(filteredIssues.length + ' issues found\n');
resolve(filteredIssues);
}
});
});
}
/**
* Get the blocks of issues based on release dates
*
* @since 0.5.0
* @private
*
* @param {GithubReleaseNotes} gren
* @param {Array} releaseRanges The array of date ranges
*
* @return {Promise[]}
*/
function getIssueBlocks(gren, releaseRanges) {
console.log('\nCreating the body blocks from issues:');
return getClosedIssues(gren, releaseRanges)
.then(function(issues) {
return releaseRanges
.map(function(range) {
var body = (!range[0].body || gren.options.override) &&
issues.filter(function(issue) {
return utils.isInRange(
Date.parse(issue.closed_at),
Date.parse(range[1].date),
Date.parse(range[0].date)
);
})
.map(templateIssue);
return {
id: range[0].id,
release: range[0].name,
date: range[0].date,
body: templateIssueBody(body, range[0].body)
};
});
});
}
/**
* Sort releases by dates
*
* @since 0.5.0
* @private
*
* @param {Array} releaseDates
*
* @return {Array}
*/
function sortReleasesByDate(releaseDates) {
return releaseDates.sort(function(release1, release2) {
return new Date(release1.date) < new Date(release2.date) ? 1 : -1;
});
}
/**
* Create the ranges of release dates
*
* @since 0.5.0
* @private
*
* @param {GithubReleaseNotes} gren
* @param {Array} releaseDates The release dates
*
* @return {Array}
*/
function createReleaseRanges(gren, releaseDates) {
var ranges = [];
var range = 2;
var sortedReleaseDates = sortReleasesByDate(releaseDates);
if (sortedReleaseDates.length === 1 || gren.options.timeWrap === 'history') {
sortedReleaseDates.push({
id: 0,
date: new Date(0)
});
}
for (var i = 0; i < sortedReleaseDates.length - 1; i++) {
ranges.push(sortedReleaseDates.slice(i, i + range));
}
return ranges;
}
/**
* Generate a CHANGELOG.md file based on Time and issues
*
* @since 0.5.0
* @private
*
* @return {Promise[]}
*/
function generateReleaseDatesChangelogBody(gren) {
var releaseActions = {
history: getListReleases,
latest: getLastTwoReleases
};
var dataSource = {
issues: getIssueBlocks,
commits: getCommitBlocks
};
return releaseActions[gren.options.timeWrap](gren)
.then(function(releases) {
if (releases.length === 0) {
throw chalk.red('There are no releases! Run gren to generate release notes');
}
var releaseRanges = createReleaseRanges(gren, getReleaseDates(gren, releases));
return dataSource[gren.options.dataSource](gren, releaseRanges);
})
.then(function(blocks) {
return templateChangelog(blocks);
});
}
/**
* Create the CHANGELOG.md file
*
* @since 0.5.0
* @private
*
* @param {string} body
*
* @return {boolean}
*/
function createChangelog(gren, body) {
function createFile(fileBody) {
fs.writeFile(gren.options.changelogFilename, fileBody, function(err) {
if (err) {
throw err;
}
process.stdout.write('\n' + chalk.green('The changelog file has been saved!\n'));
return true;
});
}
try {
fs.readFile(gren.options.changelogFilename, 'utf-8', function(err, data) {
if (err) {
console.error(chalk.red(err));
return;
}
var newReleaseName = body.match(/(##\s[\w\.]+)/)[0];
if (data.match(newReleaseName)) {
if (gren.options.force) {
createFile(body + '\n\n --- \n\n' + data.replace(/^(#\s?\w*\n\n)/g, ''));
return true;
} else if (gren.options.override) {
createFile(body);
return true;
}
console.error(chalk.red('\nThis release is already in the changelog\n'));
return false;
}
createFile(body + '\n --- \n\n' + data.replace(/^(#\s?\w*\n\n)/g, ''));
});
} catch (e) {
createFile(body);
}
}
/**
* Generate the GithubReleaseNotes getting the options from the git config
*
* @since 0.5.0
* @private
*
* @return {Promise[]}
*/
function generateOptions(options) {
return Promise.all([
options.user ? Promise.resolve(options.user) : githubInfo.user(),
options.repo ? Promise.resolve(options.repo) : githubInfo.repo(),
options.token ? Promise.resolve(options.token) : githubInfo.token()
]);
}
/**
* Check if there is connectivity
*
* @since 0.5.0
* @private
*
* @return {Promise}
*/
function hasNetwork() {
return new Promise(function(resolve, reject) {
isOnline(function(err, online) {
if (err) {
reject(chalk.red(err));
}
resolve(online);
});
});
}
/**
* @param {Object} [options] The options of the module
*
* @since 0.1.0
* @public
*
* @constructor
*/
function GithubReleaseNotes(options) {
this.options = ObjectAssign({}, defaults, options || utils.getBashOptions(process.argv));
this.options.tags = this.options.tags && this.options.tags.split(',');
this.repo = null;
this.issues = null;
this.isEditingLatestRelease = false;
}
/**
* Initialise the GithubReleaseNotes module, create the options and run
* a given module method
*
* @since 0.5.0
* @public
*
* @param {function} action
*
* @return {Promise} The generated options
*/
GithubReleaseNotes.prototype.init = function() {
var gren = this;
return hasNetwork()
.then(function(success) {
if (success) {
return generateOptions(gren.options);
} else {
throw chalk.red('You need to have network connectivity');
}
})
.then(function(optionData) {
gren.options = ObjectAssign(...optionData, gren.options);
if (!gren.options.token) {
throw chalk.red('You need to provide the token');
}
var githubApi = new Github({
token: gren.options.token
});
gren.repo = githubApi.getRepo(gren.options.username, gren.options.repo);
gren.issues = githubApi.getIssues(gren.options.username, gren.options.repo);
return true;
})
.catch(function(error) {
console.log(error);
});
};
/**
* Get All the tags, get the dates, get the commits between those dates and prepeare the release
*
* @since 0.1.0
* @public
*
* @return {Promise}
*/
GithubReleaseNotes.prototype.release = function() {
utils.printTask('\nRelease');
var loaded;
var gren = this;
var dataSource = {
issues: getIssueBlocks,
commits: getCommitBlocks
};
return getListReleases(this)
.then(function(releases) {
return getLastTags(gren, releases.length ? releases : false);
})
.then(function(tags) {
loaded = utils.task('Getting the tag dates ranges');
return Promise.all(getTagDates(gren, tags));
})
.then(function(releaseDates) {
loaded();
return dataSource[gren.options.dataSource](
gren,
createReleaseRanges(gren, releaseDates)
);
})
.then(function(blocks) {
return prepareRelease(gren, blocks[0]);
})
.then(function(success) {
return success;
})
.catch(function(error) {
console.error(error);
return gren.options.force;
});
};
/**
* Generate the Changelog
*
* @since 0.5.0
* @public
*
* @param {string} type The type of changelog
*/
GithubReleaseNotes.prototype.changelog = function() {
utils.printTask('\nChangelog');
var gren = this;
return generateReleaseDatesChangelogBody(this)
.then(function(changelogBody) {
return createChangelog(gren, changelogBody);
})
.then(function(success) {
return success;
})
.catch(function(error) {
console.error(error);
return gren.options.force;
});
};
module.exports = GithubReleaseNotes;