gh-action-bump-version/index.js

308 lines
11 KiB
JavaScript
Raw Normal View History

2021-10-05 17:19:01 +00:00
// test
2021-08-08 01:28:27 +00:00
const { execSync, spawn } = require('child_process');
const { existsSync } = require('fs');
2021-08-08 01:28:27 +00:00
const { EOL } = require('os');
const path = require('path');
2019-10-26 19:06:00 +00:00
2020-01-13 14:04:50 +00:00
// Change working directory if user defined PACKAGEJSON_DIR
if (process.env.PACKAGEJSON_DIR) {
2021-05-20 20:54:50 +00:00
process.env.GITHUB_WORKSPACE = `${process.env.GITHUB_WORKSPACE}/${process.env.PACKAGEJSON_DIR}`;
process.chdir(process.env.GITHUB_WORKSPACE);
2022-11-03 14:29:47 +00:00
} else if (process.env.INPUT_PACKAGEJSON_DIR) {
process.env.GITHUB_WORKSPACE = `${process.env.GITHUB_WORKSPACE}/${process.env.INPUT_PACKAGEJSON_DIR}`;
2021-05-20 20:54:50 +00:00
process.chdir(process.env.GITHUB_WORKSPACE);
2020-01-13 14:04:50 +00:00
}
2022-10-27 16:12:24 +00:00
console.log('process.env.GITHUB_WORKSPACE', process.env.GITHUB_WORKSPACE);
const workspace = process.env.GITHUB_WORKSPACE;
const pkg = getPackageJson();
(async () => {
2021-08-08 01:28:27 +00:00
const event = process.env.GITHUB_EVENT_PATH ? require(process.env.GITHUB_EVENT_PATH) : {};
2019-10-26 19:06:00 +00:00
2022-09-02 22:55:28 +00:00
if (!event.commits && !process.env['INPUT_VERSION-TYPE']) {
2021-05-20 20:54:50 +00:00
console.log("Couldn't find any commits in this event, incrementing patch version...");
}
2022-10-26 19:07:21 +00:00
const allowedTypes = ['major', 'minor', 'patch', 'prerelease'];
2022-09-02 23:03:21 +00:00
if (process.env['INPUT_VERSION-TYPE'] && !allowedTypes.includes(process.env['INPUT_VERSION-TYPE'])) {
2022-09-02 22:55:28 +00:00
exitFailure('Invalid version type');
return;
}
const versionType = process.env['INPUT_VERSION-TYPE'];
2021-07-01 20:10:38 +00:00
const tagPrefix = process.env['INPUT_TAG-PREFIX'] || '';
2022-11-20 20:50:01 +00:00
const tagSuffix = process.env['INPUT_TAG-SUFFIX'] || '';
2022-05-31 18:53:50 +00:00
console.log('tagPrefix:', tagPrefix);
2022-11-20 20:50:01 +00:00
console.log('tagSuffix:', tagSuffix);
2023-05-12 08:08:36 +00:00
const checkLastCommitOnly = process.env['INPUT_CHECK-LAST-COMMIT-ONLY'] || 'false';
2023-05-12 07:28:57 +00:00
let messages = []
2023-05-12 08:08:36 +00:00
if (checkLastCommitOnly === 'true') {
console.log('Only checking the last commit...');
2023-05-12 09:35:59 +00:00
const commit = event.commits && event.commits.lengths > 0 ? event.commits[event.commits.length - 1] : null;
2023-05-12 07:28:57 +00:00
messages = commit ? [commit.message + '\n' + commit.body] : [];
} else {
2023-05-12 07:28:57 +00:00
messages = event.commits ? event.commits.map((commit) => commit.message + '\n' + commit.body) : [];
}
2021-05-20 20:54:50 +00:00
const commitMessage = process.env['INPUT_COMMIT-MESSAGE'] || 'ci: version bump to {{version}}';
2021-07-01 20:10:38 +00:00
console.log('commit messages:', messages);
2022-01-13 20:25:09 +00:00
const bumpPolicy = process.env['INPUT_BUMP-POLICY'] || 'all';
2022-11-20 20:50:01 +00:00
const commitMessageRegex = new RegExp(commitMessage.replace(/{{version}}/g, `${tagPrefix}\\d+\\.\\d+\\.\\d+${tagSuffix}`), 'ig');
2022-01-13 20:25:09 +00:00
let isVersionBump = false;
if (bumpPolicy === 'all') {
isVersionBump = messages.find((message) => commitMessageRegex.test(message)) !== undefined;
} else if (bumpPolicy === 'last-commit') {
isVersionBump = messages.length > 0 && commitMessageRegex.test(messages[messages.length - 1]);
} else if (bumpPolicy === 'ignore') {
console.log('Ignoring any version bumps in commits...');
} else {
console.warn(`Unknown bump policy: ${bumpPolicy}`);
}
2019-10-26 19:06:00 +00:00
if (isVersionBump) {
exitSuccess('No action necessary because we found a previous bump!');
2021-05-20 20:54:50 +00:00
return;
2019-10-26 19:06:00 +00:00
}
2021-07-01 18:17:11 +00:00
// input wordings for MAJOR, MINOR, PATCH, PRE-RELEASE
const majorWords = process.env['INPUT_MAJOR-WORDING'].split(',').filter((word) => word != '');
const minorWords = process.env['INPUT_MINOR-WORDING'].split(',').filter((word) => word != '');
2021-07-01 20:10:38 +00:00
// patch is by default empty, and '' would always be true in the includes(''), thats why we handle it separately
const patchWords = process.env['INPUT_PATCH-WORDING'] ? process.env['INPUT_PATCH-WORDING'].split(',') : null;
2021-11-22 12:54:01 +00:00
const preReleaseWords = process.env['INPUT_RC-WORDING'] ? process.env['INPUT_RC-WORDING'].split(',') : null;
2020-10-06 15:50:52 +00:00
2021-07-01 20:10:38 +00:00
console.log('config words:', { majorWords, minorWords, patchWords, preReleaseWords });
2021-07-01 18:17:11 +00:00
// get default version bump
let version = process.env.INPUT_DEFAULT;
2021-05-20 20:54:50 +00:00
let foundWord = null;
2021-07-01 18:17:11 +00:00
// get the pre-release prefix specified in action
let preid = process.env.INPUT_PREID;
2021-07-01 10:08:46 +00:00
2022-09-02 22:55:28 +00:00
// case if version-type found
if (versionType) {
version = versionType;
}
2021-07-01 18:17:11 +00:00
// case: if wording for MAJOR found
2022-09-02 22:55:28 +00:00
else if (
2021-05-20 20:54:50 +00:00
messages.some(
(message) => /^([a-zA-Z]+)(\(.+\))?(\!)\:/.test(message) || majorWords.some((word) => message.includes(word)),
)
) {
version = 'major';
2021-07-01 18:17:11 +00:00
}
// case: if wording for MINOR found
else if (messages.some((message) => minorWords.some((word) => message.includes(word)))) {
2021-05-20 20:54:50 +00:00
version = 'minor';
2021-07-01 18:17:11 +00:00
}
// case: if wording for PATCH found
2021-07-01 20:10:38 +00:00
else if (patchWords && messages.some((message) => patchWords.some((word) => message.includes(word)))) {
2021-07-01 12:16:01 +00:00
version = 'patch';
2021-07-01 18:17:11 +00:00
}
// case: if wording for PRE-RELEASE found
else if (
2021-11-22 12:54:01 +00:00
preReleaseWords &&
2021-05-20 20:54:50 +00:00
messages.some((message) =>
preReleaseWords.some((word) => {
if (message.includes(word)) {
foundWord = word;
return true;
} else {
return false;
}
}),
)
) {
2022-10-26 19:07:21 +00:00
if (foundWord !== '') {
2021-07-07 00:33:48 +00:00
preid = foundWord.split('-')[1];
2022-06-28 12:06:15 +00:00
}
2021-05-20 20:54:50 +00:00
version = 'prerelease';
2020-10-09 16:55:11 +00:00
}
2021-07-01 20:10:38 +00:00
console.log('version action after first waterfall:', version);
// case: if default=prerelease,
// rc-wording is also set
// and does not include any of rc-wording
2022-10-26 18:56:40 +00:00
// and version-type is not strictly set
// then unset it and do not run
2021-07-01 20:10:38 +00:00
if (
version === 'prerelease' &&
2021-11-22 12:54:01 +00:00
preReleaseWords &&
2022-11-03 21:25:26 +00:00
!messages.some((message) => preReleaseWords.some((word) => message.includes(word))) &&
!versionType
2021-07-01 20:10:38 +00:00
) {
2021-07-01 18:17:11 +00:00
version = null;
}
// case: if default=prerelease, but rc-wording is NOT set
2021-07-01 13:01:06 +00:00
if (version === 'prerelease' && preid) {
2021-05-20 20:54:50 +00:00
version = `${version} --preid=${preid}`;
}
2021-07-01 20:10:38 +00:00
console.log('version action after final decision:', version);
2021-07-01 18:17:11 +00:00
// case: if nothing of the above matches
if (!version) {
exitSuccess('No version keywords found, skipping bump.');
2021-05-20 20:54:50 +00:00
return;
2019-10-26 19:06:00 +00:00
}
2021-07-13 21:43:33 +00:00
// case: if user sets push to false, to skip pushing new tag/package.json
const push = process.env['INPUT_PUSH'];
if (push === 'false' || push === false) {
exitSuccess('User requested to skip pushing new tag and package.json. Finished.');
2021-07-13 21:38:26 +00:00
return;
}
2021-07-01 18:17:11 +00:00
// GIT logic
2019-10-26 19:06:00 +00:00
try {
2021-05-20 20:54:50 +00:00
const current = pkg.version.toString();
2019-10-26 19:42:48 +00:00
// set git user
await runInWorkspace('git', ['config', 'user.name', `"${process.env.GITHUB_USER || 'Automated Version Bump'}"`]);
await runInWorkspace('git', [
2021-05-20 20:54:50 +00:00
'config',
'user.email',
`"${process.env.GITHUB_EMAIL || 'gh-action-bump-version@users.noreply.github.com'}"`,
]);
2019-10-26 19:42:48 +00:00
2022-06-28 12:02:27 +00:00
let currentBranch;
2021-05-20 20:54:50 +00:00
let isPullRequest = false;
2020-09-26 12:13:48 +00:00
if (process.env.GITHUB_HEAD_REF) {
2020-09-26 12:34:59 +00:00
// Comes from a pull request
2021-05-20 20:54:50 +00:00
currentBranch = process.env.GITHUB_HEAD_REF;
isPullRequest = true;
2022-06-28 12:02:27 +00:00
} else {
let regexBranch = /refs\/[a-zA-Z]+\/(.*)/.exec(process.env.GITHUB_REF);
// If GITHUB_REF is null then do not set the currentBranch
currentBranch = regexBranch ? regexBranch[1] : undefined;
2020-09-26 12:13:48 +00:00
}
2020-11-25 14:47:18 +00:00
if (process.env['INPUT_TARGET-BRANCH']) {
// We want to override the branch that we are pulling / pushing to
2021-05-20 20:54:50 +00:00
currentBranch = process.env['INPUT_TARGET-BRANCH'];
}
2021-05-20 20:54:50 +00:00
console.log('currentBranch:', currentBranch);
2022-05-31 18:34:44 +00:00
if (!currentBranch) {
exitFailure('No branch found');
return;
}
// do it in the current checked out github branch (DETACHED HEAD)
// important for further usage of the package.json version
await runInWorkspace('npm', ['version', '--allow-same-version=true', '--git-tag-version=false', current]);
2022-05-31 18:53:50 +00:00
console.log('current 1:', current, '/', 'version:', version);
let newVersion = execSync(`npm version --git-tag-version=false ${version}`).toString().trim().replace(/^v/, '');
2022-05-31 19:11:01 +00:00
console.log('newVersion 1:', newVersion);
2022-11-20 20:50:01 +00:00
newVersion = `${tagPrefix}${newVersion}${tagSuffix}`;
if (process.env['INPUT_SKIP-COMMIT'] !== 'true') {
await runInWorkspace('git', ['commit', '-a', '-m', commitMessage.replace(/{{version}}/g, newVersion)]);
}
// now go to the actual branch to perform the same versioning
if (isPullRequest) {
// First fetch to get updated local version of branch
await runInWorkspace('git', ['fetch']);
}
await runInWorkspace('git', ['checkout', currentBranch]);
await runInWorkspace('npm', ['version', '--allow-same-version=true', '--git-tag-version=false', current]);
2022-05-31 18:53:50 +00:00
console.log('current 2:', current, '/', 'version:', version);
console.log('execute npm version now with the new version:', version);
newVersion = execSync(`npm version --git-tag-version=false ${version}`).toString().trim().replace(/^v/, '');
2022-05-31 22:10:19 +00:00
// fix #166 - npm workspaces
// https://github.com/phips28/gh-action-bump-version/issues/166#issuecomment-1142640018
newVersion = newVersion.split(/\n/)[1] || newVersion;
2022-05-31 19:11:01 +00:00
console.log('newVersion 2:', newVersion);
2022-11-20 20:50:01 +00:00
newVersion = `${tagPrefix}${newVersion}${tagSuffix}`;
console.log(`newVersion after merging tagPrefix+newVersion+tagSuffix: ${newVersion}`);
// Using sh as command instead of directly echo to be able to use file redirection
2023-06-28 17:18:03 +00:00
try {
await runInWorkspace('sh', ['-c', `echo "newTag=${newVersion}" >> $GITHUB_OUTPUT`]);
} catch {
// for runner < 2.297.0
console.log(`::set-output name=newTag::${newVersion}`);
}
2020-04-03 23:39:59 +00:00
try {
// to support "actions/checkout@v1"
if (process.env['INPUT_SKIP-COMMIT'] !== 'true') {
await runInWorkspace('git', ['commit', '-a', '-m', commitMessage.replace(/{{version}}/g, newVersion)]);
}
2020-04-03 23:39:59 +00:00
} catch (e) {
2021-05-20 20:54:50 +00:00
console.warn(
'git commit failed because you are using "actions/checkout@v2" or later; ' +
'but that doesnt matter because you dont need that git commit, thats only for "actions/checkout@v1"',
2021-05-20 20:54:50 +00:00
);
2020-04-03 23:39:59 +00:00
}
2020-04-03 11:04:35 +00:00
2021-05-20 20:54:50 +00:00
const remoteRepo = `https://${process.env.GITHUB_ACTOR}:${process.env.GITHUB_TOKEN}@github.com/${process.env.GITHUB_REPOSITORY}.git`;
2020-09-06 11:13:52 +00:00
if (process.env['INPUT_SKIP-TAG'] !== 'true') {
await runInWorkspace('git', ['tag', newVersion]);
2021-12-09 03:20:01 +00:00
if (process.env['INPUT_SKIP-PUSH'] !== 'true') {
await runInWorkspace('git', ['push', remoteRepo, '--follow-tags']);
await runInWorkspace('git', ['push', remoteRepo, '--tags']);
}
} else {
2021-12-09 03:20:01 +00:00
if (process.env['INPUT_SKIP-PUSH'] !== 'true') {
await runInWorkspace('git', ['push', remoteRepo]);
}
2020-09-06 11:13:52 +00:00
}
2019-10-26 19:06:00 +00:00
} catch (e) {
2021-08-08 01:28:27 +00:00
logError(e);
exitFailure('Failed to bump version');
return;
2019-10-26 19:06:00 +00:00
}
exitSuccess('Version bumped!');
})();
function getPackageJson() {
const pathToPackage = path.join(workspace, 'package.json');
if (!existsSync(pathToPackage)) throw new Error("package.json could not be found in your project's root.");
2021-08-08 01:28:27 +00:00
return require(pathToPackage);
}
function exitSuccess(message) {
2021-08-08 01:28:27 +00:00
console.info(`✔ success ${message}`);
process.exit(0);
}
function exitFailure(message) {
2021-08-08 01:28:27 +00:00
logError(message);
process.exit(1);
}
2021-08-08 01:28:27 +00:00
function logError(error) {
console.error(`✖ fatal ${error.stack || error}`);
}
function runInWorkspace(command, args) {
2021-08-08 01:28:27 +00:00
return new Promise((resolve, reject) => {
2022-10-27 16:12:24 +00:00
console.log('runInWorkspace | command:', command, 'args:', args);
2021-08-08 01:28:27 +00:00
const child = spawn(command, args, { cwd: workspace });
let isDone = false;
const errorMessages = [];
child.on('error', (error) => {
if (!isDone) {
isDone = true;
reject(error);
}
});
child.stderr.on('data', (chunk) => errorMessages.push(chunk));
child.on('exit', (code) => {
if (!isDone) {
if (code === 0) {
resolve();
} else {
reject(`${errorMessages.join('')}${EOL}${command} exited with code ${code}`);
}
}
});
});
//return execa(command, args, { cwd: workspace });
}