/
updateChangelog.js
176 lines (167 loc) · 4.17 KB
/
updateChangelog.js
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
import path from 'path';
import fs from 'fs';
import conventionalChangelog from 'conventional-changelog';
import tempfile from 'tempfile';
import addStream from 'add-stream';
import runStep from '../runStep';
import { parseArgs } from '../../util';
export default ({
config,
firstRelease,
releaseCount,
revisionRange,
dir,
dryRun,
}) =>
runStep(
{
title: 'Updating the changelog.',
skipIf: () => config.updateChangelog !== true,
},
() => {
if (dryRun) {
return Promise.resolve();
}
return new Promise((resolve, reject) => {
const { conventionalChangelogArgs } = config;
const { args, gitRawCommitsOpts, templateContext } = prepareParams({
dir,
conventionalChangelogArgs,
releaseCount,
firstRelease,
revisionRange,
reject,
});
runConventionalChangelog({
args,
templateContext,
gitRawCommitsOpts,
resolve,
reject,
});
});
}
);
// The following implementation is mostly based on this file:
// https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-cli/cli.js
const argSpec = {
'--infile': String,
'--outfile': String,
'--same-file': Boolean,
'--preset': String,
'--pkg': String,
'--append': Boolean,
'--release-count': Number,
'--output-unreleased': Boolean,
'--verbose': Boolean,
'--config': String,
'--context': String,
'--lerna-package': String,
'--tag-prefix': String,
'--commit-path': String,
// Aliases
'-i': '--infile',
'-o': '--outfile',
'-s': '--same-file',
'-p': '--preset',
'-k': '--pkg',
'-a': '--append',
'-r': '--release-count',
'-u': '--output-unreleased',
'-v': '--verbose',
'-n': '--config',
'-c': '--context',
'-l': '--lerna-package',
'-t': '--tag-prefix',
};
function prepareParams({
dir,
conventionalChangelogArgs,
releaseCount,
firstRelease,
revisionRange,
reject,
}) {
const args = parseArgs(argSpec, (conventionalChangelogArgs || '').split(' '));
if (args.infile && args.infile === args.outfile) {
args.sameFile = true;
} else if (args.sameFile) {
if (args.infile) {
args.outfile = args.infile;
} else {
reject(new Error('infile must be provided if same-file flag presents.'));
return undefined;
}
}
args.infile = path.resolve(dir, args.infile);
args.outfile = path.resolve(dir, args.outfile);
if (releaseCount !== undefined) {
args.releaseCount = releaseCount;
}
if (firstRelease !== undefined) {
args.firstRelease = firstRelease;
}
args.pkg = {
path: args.pkg || dir,
};
const [from, to] = revisionRange.split('..');
const gitRawCommitsOpts = {
from,
to,
};
if (args.commitPath) {
gitRawCommitsOpts.path = args.commitPath;
}
const templateContext =
args.context && require(path.resolve(dir, args.context));
return { args, gitRawCommitsOpts, templateContext };
}
function runConventionalChangelog({
args,
templateContext,
gitRawCommitsOpts,
resolve,
reject,
}) {
const changelogStream = conventionalChangelog(
args,
templateContext,
gitRawCommitsOpts
).on('error', reject);
const readStream = fs.createReadStream(args.infile).on('error', reject);
if (args.sameFile) {
if (args.append) {
changelogStream
.pipe(
fs.createWriteStream(args.outfile, {
flags: 'a',
})
)
.on('finish', resolve);
} else {
const tmp = tempfile();
changelogStream
.pipe(addStream(readStream))
.pipe(fs.createWriteStream(tmp))
.on('finish', () => {
fs.createReadStream(tmp)
.pipe(fs.createWriteStream(args.outfile))
.on('finish', resolve);
});
}
} else {
let outStream;
if (args.outfile) {
outStream = fs.createWriteStream(args.outfile);
} else {
outStream = process.stdout;
}
let stream;
if (args.append) {
stream = readStream.pipe(addStream(changelogStream));
} else {
stream = changelogStream.pipe(addStream(readStream));
}
stream.pipe(outStream).on('finish', resolve);
}
}