Repository navigation
Expand file tree
/
Copy pathrelease.js
More file actions
241 lines (205 loc) · 7.8 KB
/
Copy pathrelease.js
File metadata and controls
241 lines (205 loc) · 7.8 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
const { execSync } = require('child_process');
const readline = require('readline');
const fs = require('fs');
const releaseBranchName = 'release-';
const printUsage = () => {
console.log(`Run without arguments to perform operation based on current branch (main or release-1.XX branch).
Or specify the operation as an argument:
create-release - create the next minor release branch '${releaseBranchName}1.XX'. invoke from main branch.
finalize-release - finalize the package version and tag the release. invoke from release branch.
`);
};
const exec = (command) => {
console.log(`exec: '${command}'`);
return execSync(command).toString().trim();
};
// read package version and return in a structure.
const readPackageVersion = () => {
const version = require('./package.json').version;
const versionParts = version.split('-');
const versionNumbers = versionParts[0].split('.').map((v) => {
const intV = parseInt(v, 10);
if (isNaN(intV)) {
throw new Error(`error: unable to parse version '${version}'.`);
}
return intV;
});
if (versionNumbers.length !== 3) {
throw new Error(`error: unable to parse version '${version}'.`);
}
return {
major: versionNumbers[0],
minor: versionNumbers[1],
patch: versionNumbers[2],
build: versionParts[1] || null
};
};
// bump package version. releaseType is major, minor or patch
const bumpPackageVersion = (version, releaseType) => {
switch (releaseType) {
case 'major':
return {
major: version.major + 1,
minor: 0,
patch: 0,
build: version.build
};
case 'minor':
return {
major: version.major,
minor: version.minor + 1,
patch: 0,
build: version.build
};
case 'patch':
return {
major: version.major,
minor: version.minor,
patch: version.patch + 1,
build: version.build
};
}
};
// this function evolves the package version for releases.
// when a new (minor) release branch is made, the version is tagged as preview build, e.g. '1.48.0-preview'.
// at publish time, this version will evolve to '1.48.0'.
// at next publish time, this version will evolve to '1.48.1'.
// etc
const evolvePackageVersion = (version) => {
return version.build ? {
major: version.major,
minor: version.minor,
patch: version.patch,
build: null
} : bumpPackageVersion(version, 'patch');
};
// write package version to package.json
const writePackageVersion = (version) => {
const packageJson = require('./package.json');
packageJson.version = `${version.major}.${version.minor}.${version.patch}` + (version.build ? `-${version.build}` : '');
fs.writeFileSync('./package.json', JSON.stringify(packageJson, null, 2) + '\n');
};
// ask user a question and invoke callback if user responds yes (using enter, y or Y).
const getUserConfirmation = (question, callback) => {
const rl = readline.createInterface({
input: process.stdin,
output: process.stdout
});
rl.question(question, (response) => {
rl.close();
if (response !== '' && response !== 'y' && response !== 'Y') {
process.exit(1);
}
callback();
});
};
// create a new release branch.
// assumed called from main.
// updates package versions on main and newly created release branch.
const createRelease = (mainBranch) => {
// check branch name
if (mainBranch !== 'main') {
console.log(`warning: source branch is not 'main'.`);
}
// read current package version. this contains the version we're releasing.
const mainVersion = readPackageVersion();
if (mainVersion.build !== 'main') {
// say something?
console.warn(`warning: package isn't tagged as 'main' build.`);
}
// build release branch string
const releaseBranch = `${releaseBranchName}${mainVersion.major}.${mainVersion.minor}`;
const releaseMessage = `Branch ${mainVersion.major}.${mainVersion.minor}`;
// print summary and get user buy-in
const question = `About to create minor release branch '${releaseBranch}' taken from '${mainBranch}' branch.\nContinue? (Y/n) `;
getUserConfirmation(question, () => {
// create branch for the new minor release
exec(`git branch ${releaseBranch} ${mainBranch}`);
// write next minor version to the main package
writePackageVersion(bumpPackageVersion(mainVersion, 'minor'));
// commit with message indicating release branch
exec(`git commit -m "${releaseMessage}" -- package.json`);
// checkout release branch
exec(`git checkout ${releaseBranch}`);
// update package version build to 'preview'
writePackageVersion({
major: mainVersion.major,
minor: mainVersion.minor,
patch: mainVersion.patch,
build: 'preview'
});
exec(`git commit -m "${releaseMessage}" -- package.json`);
});
return 0;
};
// tag the current branch for release
const finalizeRelease = (curBranch) => {
// check branch name
if (!curBranch.startsWith(releaseBranchName)) {
console.log(`warning: current branch '${curBranch}' does not start with '${releaseBranchName}'.`);
}
// get the current package version
const curVersion = readPackageVersion();
// sanity check package version
if (curVersion.build && curVersion.patch !== 0) {
console.log(`warning: package version has unexpected build '${curVersion.build}'.`);
}
// calculate the new version - either first minor release or patch release
const newVersion = evolvePackageVersion(curVersion);
const versionString = `v${newVersion.major}.${newVersion.minor}.${newVersion.patch}`;
const tags = exec('git tag');
if (new RegExp(`^${versionString}$`, 'm').test(tags)) {
throw new Error(`error: tag already exists '${versionString}'.`);
}
// get user confirmation
const question = `About to finalize and tag branch '${curBranch}' with version '${versionString}'.\nContinue? (Y/n) `;
getUserConfirmation(question, () => {
writePackageVersion(newVersion);
exec(`git commit -m "${versionString}" -- package.json`);
exec(`git tag ${versionString}`);
});
};
const run = () => {
const getCurrentBranch = () => exec('git branch --show-current');
if (process.argv.length === 2) {
// use current branch to decide operation
const curBranch = getCurrentBranch();
if (curBranch === 'main') {
createRelease(curBranch);
return 0;
} else if (curBranch.startsWith(releaseBranchName)) {
finalizeRelease(curBranch);
return 0;
} else {
console.error(`error: unrecognized branch '${curBranch}.`);
printUsage();
return 1;
}
} else if (process.argv.length === 3) {
// operation specified as arg
const operation = process.argv[2];
switch (operation) {
case 'create-release':
createRelease(getCurrentBranch());
return 0;
case 'finalize-release':
finalizeRelease(getCurrentBranch());
return 0;
default:
console.error(`error: unrecognized operation '${operation}.`);
printUsage();
return 1;
}
} else {
console.log(`Prepare the engine for release.`);
printUsage();
return 1;
}
};
// install global error handler
process.on('uncaughtException', (err) => {
console.error(err.message);
process.exitCode = 1;
});
// run
process.exitCode = run();