actions/semantic-version
9
0
Fork 0
mirror of https://github.com/PaulHatch/semantic-version.git synced 2026-02-27 16:02:07 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore(deps): upgrade dependencies and drop ESLint

Browse source
This commit is contained in:
Paul Hatcherian 2026-01-18 17:30:33 -06:00
parent 45a5cbb476
commit 3337b3eed3
30 changed files with 831 additions and 4024 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
.eslintrc.json
View file

@ -1,21 +0,0 @@
{
"parser": "@typescript-eslint/parser",
"plugins": ["jest"],
"env": {
"es6": true,
"node": true,
"jest/globals": true
},
"extends": ["eslint:recommended"],
"globals": {
"Atomics": "readonly",
"SharedArrayBuffer": "readonly"
},
"parserOptions": {
"ecmaVersion": 2018,
"sourceType": "module"
},
"rules": {
"no-unused-vars": "off"
}
}

3
.github/workflows/ci.yml vendored
View file

@ -37,9 +37,6 @@ jobs:
- name: Format check
run: npm run format-check
- name: Lint
run: npm run lint
- name: Test
run: npm test

4
.prettierignore Normal file
View file

@ -0,0 +1,4 @@
dist/
node_modules/
lib/
*.md

225
dist/index.js vendored
View file

@ -379,17 +379,17 @@ const DefaultTagFormatter_1 = __nccwpck_require__(2865);
class BranchVersioningTagFormatter extends DefaultTagFormatter_1.DefaultTagFormatter {
getRegex(pattern) {
if (/^\/.+\/[i]*$/.test(pattern)) {
const regexEnd = pattern.lastIndexOf('/');
const parsedFlags = pattern.slice(pattern.lastIndexOf('/') + 1);
const regexEnd = pattern.lastIndexOf("/");
const parsedFlags = pattern.slice(pattern.lastIndexOf("/") + 1);
return new RegExp(pattern.slice(1, regexEnd), parsedFlags);
}
return new RegExp(pattern);
}
constructor(config, branchName) {
super(config);
const pattern = config.versionFromBranch === true ?
new RegExp("[0-9]+.[0-9]+$|[0-9]+$") :
this.getRegex(config.versionFromBranch);
const pattern = config.versionFromBranch === true
? new RegExp("[0-9]+.[0-9]+$|[0-9]+$")
: this.getRegex(config.versionFromBranch);
const result = pattern.exec(branchName);
if (result === null) {
this.major = NaN;
@ -408,7 +408,7 @@ class BranchVersioningTagFormatter extends DefaultTagFormatter_1.DefaultTagForma
throw new Error(`Unable to parse version from branch named '${branchName}' using pattern '${pattern}'`);
}
this.onVersionBranch = true;
const versionValues = branchVersion.split('.');
const versionValues = branchVersion.split(".");
if (versionValues.length > 2) {
throw new Error(`The version string '${branchVersion}' parsed from branch '${branchName}' is invalid. It must be in the format 'major.minor' or 'major'`);
}
@ -429,9 +429,9 @@ class BranchVersioningTagFormatter extends DefaultTagFormatter_1.DefaultTagForma
return pattern;
}
if (this.minor === undefined) {
return pattern.replace('*[0-9].*[0-9].*[0-9]', `${this.major}.*[0-9].*[0-9]`);
return pattern.replace("*[0-9].*[0-9].*[0-9]", `${this.major}.*[0-9].*[0-9]`);
}
return pattern.replace('*[0-9].*[0-9].*[0-9]', `${this.major}.${this.minor}.*[0-9]`);
return pattern.replace("*[0-9].*[0-9].*[0-9]", `${this.major}.${this.minor}.*[0-9]`);
}
IsValid(tag) {
if (!this.onVersionBranch) {
@ -474,7 +474,7 @@ class CsvUserFormatter {
// placeholder for consistency with other formatters
}
Format(type, users) {
return users.map(user => `${user.name} <${user.email}>`).join(', ');
return users.map((user) => `${user.name} <${user.email}>`).join(", ");
}
}
exports.CsvUserFormatter = CsvUserFormatter;
@ -494,7 +494,7 @@ class DefaultTagFormatter {
constructor(config) {
this.namespace = config.namespace;
this.tagPrefix = config.tagPrefix;
this.namespaceSeparator = '-'; // maybe make configurable in the future
this.namespaceSeparator = "-"; // maybe make configurable in the future
}
Format(versionInfo) {
const result = `${this.tagPrefix}${versionInfo.major}.${versionInfo.minor}.${versionInfo.patch}`;
@ -510,20 +510,20 @@ class DefaultTagFormatter {
return `${this.tagPrefix}*[0-9].*[0-9].*[0-9]`;
}
Parse(tag) {
if (tag === '') {
if (tag === "") {
return [0, 0, 0];
}
let tagParts = tag
.replace(this.tagPrefix, '<--!PREFIX!-->')
.replace(this.namespace, '<--!NAMESPACE!-->')
.split('/');
.replace(this.tagPrefix, "<--!PREFIX!-->")
.replace(this.namespace, "<--!NAMESPACE!-->")
.split("/");
const stripedTag = tagParts[tagParts.length - 1]
.replace('<--!PREFIX!-->', this.tagPrefix)
.replace('<--!NAMESPACE!-->', this.namespace);
.replace("<--!PREFIX!-->", this.tagPrefix)
.replace("<--!NAMESPACE!-->", this.namespace);
let versionValues = stripedTag
.substring(this.tagPrefix.length)
.slice(0, this.namespace === '' ? 999 : -(this.namespace.length + 1))
.split('.');
.slice(0, this.namespace === "" ? 999 : -(this.namespace.length + 1))
.split(".");
let major = parseInt(versionValues[0]);
let minor = versionValues.length > 1 ? parseInt(versionValues[1]) : 0;
let patch = versionValues.length > 2 ? parseInt(versionValues[2]) : 0;
@ -533,7 +533,7 @@ class DefaultTagFormatter {
return [major, minor, patch];
}
IsValid(tag) {
const regexEscape = (literal) => literal.replace(/\W/g, '\\$&');
const regexEscape = (literal) => literal.replace(/\W/g, "\\$&");
const tagPrefix = regexEscape(this.tagPrefix);
const namespaceSeparator = regexEscape(this.namespaceSeparator);
const namespace = regexEscape(this.namespace);
@ -561,10 +561,10 @@ class DefaultVersionFormatter {
}
Format(versionInfo) {
return this.formatString
.replace('${major}', versionInfo.major.toString())
.replace('${minor}', versionInfo.minor.toString())
.replace('${patch}', versionInfo.patch.toString())
.replace('${increment}', versionInfo.increment.toString());
.replace("${major}", versionInfo.major.toString())
.replace("${minor}", versionInfo.minor.toString())
.replace("${patch}", versionInfo.patch.toString())
.replace("${increment}", versionInfo.increment.toString());
}
}
exports.DefaultVersionFormatter = DefaultVersionFormatter;
@ -584,8 +584,8 @@ class JsonUserFormatter {
// placeholder for consistency with other formatters
}
Format(type, users) {
let result = users.map(u => ({ name: u.name, email: u.email }));
return JSON.stringify(result).replace('\n', '');
let result = users.map((u) => ({ name: u.name, email: u.email }));
return JSON.stringify(result).replace("\n", "");
}
}
exports.JsonUserFormatter = JsonUserFormatter;
@ -751,9 +751,9 @@ class BumpAlwaysVersionClassifier extends DefaultVersionClassifier_1.DefaultVers
constructor(config) {
super(config);
this.enablePrereleaseMode = config.enablePrereleaseMode;
this.patchPattern = !config.bumpEachCommitPatchPattern ?
_ => true :
this.parsePattern(config.bumpEachCommitPatchPattern, "", config.searchCommitBody);
this.patchPattern = !config.bumpEachCommitPatchPattern
? (_) => true
: this.parsePattern(config.bumpEachCommitPatchPattern, "", config.searchCommitBody);
}
ClassifyAsync(lastRelease, commitSet) {
return __awaiter(this, void 0, void 0, function* () {
@ -774,7 +774,10 @@ class BumpAlwaysVersionClassifier extends DefaultVersionClassifier_1.DefaultVers
type = VersionType_1.VersionType.Minor;
}
else if (this.patchPattern(commit) ||
(major === 0 && minor === 0 && patch === 0 && commitSet.commits.length > 0)) {
(major === 0 &&
minor === 0 &&
patch === 0 &&
commitSet.commits.length > 0)) {
type = VersionType_1.VersionType.Patch;
}
else {
@ -914,49 +917,47 @@ class DefaultCommitsProvider {
return __awaiter(this, void 0, void 0, function* () {
const logSplitter = `@@@START_RECORD`;
const formatPlaceholders = Object.entries({
hash: '%H',
subject: '%s',
body: '%b',
author: '%an',
authorEmail: '%ae',
authorDate: '%aI',
committer: '%cn',
committerEmail: '%ce',
committerDate: '%cI',
tags: '%d'
hash: "%H",
subject: "%s",
body: "%b",
author: "%an",
authorEmail: "%ae",
authorDate: "%aI",
committer: "%cn",
committerEmail: "%ce",
committerDate: "%cI",
tags: "%d",
});
const pretty = logSplitter + '%n' + formatPlaceholders
.map(x => `@@@${x[0]}%n${x[1]}`)
.join('%n');
var logCommand = `git log --pretty="${pretty}" --author-date-order ${(startHash === '' ? endHash : `${startHash}..${endHash}`)}`;
if (this.changePath !== '') {
const pretty = logSplitter +
"%n" +
formatPlaceholders.map((x) => `@@@${x[0]}%n${x[1]}`).join("%n");
var logCommand = `git log --pretty="${pretty}" --author-date-order ${startHash === "" ? endHash : `${startHash}..${endHash}`}`;
if (this.changePath !== "") {
logCommand += ` -- ${this.changePath}`;
}
const log = yield (0, CommandRunner_1.cmd)(logCommand);
const entries = log
.split(logSplitter)
.slice(1);
const commits = entries.map(entry => {
const entries = log.split(logSplitter).slice(1);
const commits = entries.map((entry) => {
const fields = entry
.split(`@@@`)
.slice(1)
.reduce((acc, value) => {
const firstLine = value.indexOf('\n');
const firstLine = value.indexOf("\n");
const key = value.substring(0, firstLine);
acc[key] = value.substring(firstLine + 1).trim();
return acc;
}, {});
const tags = fields.tags
.split(',')
.split(",")
.map((v) => v.trim())
.filter((v) => v.startsWith('tags: '))
.filter((v) => v.startsWith("tags: "))
.map((v) => v.substring(5).trim());
return new CommitInfo_1.CommitInfo(fields.hash, fields.subject, fields.body, fields.author, fields.authorEmail, new Date(fields.authorDate), fields.committer, fields.committerEmail, new Date(fields.committerDate), tags);
});
// check for changes
let changed = true;
if (this.changePath !== '') {
if (startHash === '') {
if (this.changePath !== "") {
if (startHash === "") {
const changedFiles = yield (0, CommandRunner_1.cmd)(`git log --name-only --oneline ${endHash} -- ${this.changePath}`);
changed = changedFiles.length > 0;
}
@ -997,21 +998,23 @@ class DefaultCurrentCommitResolver {
}
ResolveAsync() {
return __awaiter(this, void 0, void 0, function* () {
if (this.branch === 'HEAD') {
return (yield (0, CommandRunner_1.cmd)('git', 'rev-parse', 'HEAD')).trim();
if (this.branch === "HEAD") {
return (yield (0, CommandRunner_1.cmd)("git", "rev-parse", "HEAD")).trim();
}
return this.branch;
});
}
IsEmptyRepoAsync() {
return __awaiter(this, void 0, void 0, function* () {
let lastCommitAll = (yield (0, CommandRunner_1.cmd)('git', 'rev-list', '-n1', '--all')).trim();
return lastCommitAll === '';
let lastCommitAll = (yield (0, CommandRunner_1.cmd)("git", "rev-list", "-n1", "--all")).trim();
return lastCommitAll === "";
});
}
ResolveBranchNameAsync() {
return __awaiter(this, void 0, void 0, function* () {
const branchName = this.branch == 'HEAD' ? yield (0, CommandRunner_1.cmd)('git', 'rev-parse', '--abbrev-ref', 'HEAD') : this.branch;
const branchName = this.branch == "HEAD"
? yield (0, CommandRunner_1.cmd)("git", "rev-parse", "--abbrev-ref", "HEAD")
: this.branch;
return branchName.trim();
});
}
@ -1082,36 +1085,37 @@ class DefaultLastReleaseResolver {
return __awaiter(this, void 0, void 0, function* () {
const releasePattern = tagFormatter.GetPattern();
let currentTag = (yield (0, CommandRunner_1.cmd)(`git tag --points-at ${current} ${releasePattern}`)).trim();
currentTag = tagFormatter.IsValid(currentTag) ? currentTag : '';
const isTagged = currentTag !== '';
const [currentMajor, currentMinor, currentPatch] = currentTag ? tagFormatter.Parse(currentTag) : [null, null, null];
currentTag = tagFormatter.IsValid(currentTag) ? currentTag : "";
const isTagged = currentTag !== "";
const [currentMajor, currentMinor, currentPatch] = currentTag
? tagFormatter.Parse(currentTag)
: [null, null, null];
let tagsCount = 0;
let tag = '';
let tag = "";
try {
const refPrefixPattern = this.useBranches ? 'refs/heads/' : 'refs/tags/';
const refPrefixPattern = this.useBranches ? "refs/heads/" : "refs/tags/";
if (currentTag) {
// If we already have the current branch tagged, we are checking for the previous one
// so that we will have an accurate increment (assuming the new tag is the expected one)
const command = `git for-each-ref --sort=-v:*refname --format=%(refname:short) --merged=${current} ${refPrefixPattern}${releasePattern}`;
const tags = (yield (0, CommandRunner_1.cmd)(command)).split('\n');
const tags = (yield (0, CommandRunner_1.cmd)(command)).split("\n");
tagsCount = tags.length;
tag = tags
.find(t => tagFormatter.IsValid(t) && t !== currentTag) || '';
tag =
tags.find((t) => tagFormatter.IsValid(t) && t !== currentTag) || "";
}
else {
const command = `git for-each-ref --sort=-v:*refname --format=%(refname:short) --merged=${current} ${refPrefixPattern}${releasePattern}`;
const tags = (yield (0, CommandRunner_1.cmd)(command)).split('\n');
const tags = (yield (0, CommandRunner_1.cmd)(command)).split("\n");
tagsCount = tags.length;
tag = tags
.find(t => tagFormatter.IsValid(t)) || '';
tag = tags.find((t) => tagFormatter.IsValid(t)) || "";
}
tag = tag.trim();
}
catch (err) {
tag = '';
tag = "";
}
if (tag === '') {
if ((yield (0, CommandRunner_1.cmd)('git', 'remote')) !== '') {
if (tag === "") {
if ((yield (0, CommandRunner_1.cmd)("git", "remote")) !== "") {
// Since there is no remote, we assume that there are no other tags to pull. In
// practice this isn't likely to happen, but it keeps the test output from being
// polluted with a bunch of warnings.
@ -1119,16 +1123,16 @@ class DefaultLastReleaseResolver {
core.warning(`None of the ${tagsCount} tags(s) found were valid version tags for the present configuration. If this is unexpected, check to ensure that the configuration is correct and matches the tag format you are using. If you have not yet tagged this repo with a version tag, this can be ignored.`);
}
else {
core.warning('No tags are present for this repository. If this is unexpected, check to ensure that tags have been pulled from the remote. If you have not yet tagged this repo with a version tag, this can be ignored.');
core.warning("No tags are present for this repository. If this is unexpected, check to ensure that tags have been pulled from the remote. If you have not yet tagged this repo with a version tag, this can be ignored.");
}
}
const [major, minor, patch] = tagFormatter.Parse('');
const [major, minor, patch] = tagFormatter.Parse("");
// no release tags yet, use the initial commit as the root
return new ReleaseInformation_1.ReleaseInformation(major, minor, patch, '', currentMajor, currentMinor, currentPatch, isTagged);
return new ReleaseInformation_1.ReleaseInformation(major, minor, patch, "", currentMajor, currentMinor, currentPatch, isTagged);
}
// parse the version tag
const [major, minor, patch] = tagFormatter.Parse(tag);
const root = yield (0, CommandRunner_1.cmd)('git', `merge-base`, tag, current);
const root = yield (0, CommandRunner_1.cmd)("git", `merge-base`, tag, current);
return new ReleaseInformation_1.ReleaseInformation(major, minor, patch, root.trim(), currentMajor, currentMinor, currentPatch, isTagged);
});
}
@ -1165,18 +1169,19 @@ class DefaultVersionClassifier {
}
parsePattern(pattern, flags, searchBody) {
if (/^\/.+\/[i]*$/.test(pattern)) {
const regexEnd = pattern.lastIndexOf('/');
const parsedFlags = pattern.slice(pattern.lastIndexOf('/') + 1);
const regexEnd = pattern.lastIndexOf("/");
const parsedFlags = pattern.slice(pattern.lastIndexOf("/") + 1);
const regex = new RegExp(pattern.slice(1, regexEnd), parsedFlags || flags);
return searchBody ?
(commit) => regex.test(commit.subject) || regex.test(commit.body) :
(commit) => regex.test(commit.subject);
return searchBody
? (commit) => regex.test(commit.subject) || regex.test(commit.body)
: (commit) => regex.test(commit.subject);
}
else {
const matchString = pattern;
return searchBody ?
(commit) => commit.subject.includes(matchString) || commit.body.includes(matchString) :
(commit) => commit.subject.includes(matchString);
return searchBody
? (commit) => commit.subject.includes(matchString) ||
commit.body.includes(matchString)
: (commit) => commit.subject.includes(matchString);
}
}
getNextVersion(current, type) {
@ -1186,9 +1191,17 @@ class DefaultVersionClassifier {
return { major: current.major, minor: current.minor + 1, patch: 0 };
case VersionType_1.VersionType.Minor:
case VersionType_1.VersionType.Patch:
return { major: current.major, minor: current.minor, patch: current.patch + 1 };
return {
major: current.major,
minor: current.minor,
patch: current.patch + 1,
};
case VersionType_1.VersionType.None:
return { major: current.major, minor: current.minor, patch: current.patch };
return {
major: current.major,
minor: current.minor,
patch: current.patch,
};
default:
throw new Error(`Unknown change type: ${type}`);
}
@ -1199,33 +1212,57 @@ class DefaultVersionClassifier {
case VersionType_1.VersionType.Minor:
return { major: current.major, minor: current.minor + 1, patch: 0 };
case VersionType_1.VersionType.Patch:
return { major: current.major, minor: current.minor, patch: current.patch + 1 };
return {
major: current.major,
minor: current.minor,
patch: current.patch + 1,
};
case VersionType_1.VersionType.None:
return { major: current.major, minor: current.minor, patch: current.patch };
return {
major: current.major,
minor: current.minor,
patch: current.patch,
};
default:
throw new Error(`Unknown change type: ${type}`);
}
}
resolveCommitType(commitsSet) {
if (commitsSet.commits.length === 0) {
return { type: VersionType_1.VersionType.None, increment: 0, changed: commitsSet.changed };
return {
type: VersionType_1.VersionType.None,
increment: 0,
changed: commitsSet.changed,
};
}
const commits = commitsSet.commits.reverse();
let index = 1;
for (let commit of commits) {
if (this.majorPattern(commit)) {
return { type: VersionType_1.VersionType.Major, increment: commits.length - index, changed: commitsSet.changed };
return {
type: VersionType_1.VersionType.Major,
increment: commits.length - index,
changed: commitsSet.changed,
};
}
index++;
}
index = 1;
for (let commit of commits) {
if (this.minorPattern(commit)) {
return { type: VersionType_1.VersionType.Minor, increment: commits.length - index, changed: commitsSet.changed };
return {
type: VersionType_1.VersionType.Minor,
increment: commits.length - index,
changed: commitsSet.changed,
};
}
index++;
}
return { type: VersionType_1.VersionType.Patch, increment: commitsSet.commits.length - 1, changed: true };
return {
type: VersionType_1.VersionType.Patch,
increment: commitsSet.commits.length - 1,
changed: true,
};
}
ClassifyAsync(lastRelease, commitSet) {
return __awaiter(this, void 0, void 0, function* () {
@ -1239,7 +1276,9 @@ class DefaultVersionClassifier {
// - commit 2 - v1.0.0+1
// - commit 3 was tagged v2.0.0 - v2.0.0+0
// - commit 4 - v2.0.1+0
const versionsMatch = lastRelease.currentMajor === major && lastRelease.currentMinor === minor && lastRelease.currentPatch === patch;
const versionsMatch = lastRelease.currentMajor === major &&
lastRelease.currentMinor === minor &&
lastRelease.currentPatch === patch;
const currentIncrement = versionsMatch ? increment : 0;
return new VersionClassification_1.VersionClassification(VersionType_1.VersionType.None, currentIncrement, false, lastRelease.currentMajor, lastRelease.currentMinor, lastRelease.currentPatch);
}

2
dist/index.js.map vendored
View file

File diff suppressed because one or more lines are too long

12
jest.config.js
View file

@ -1,12 +1,10 @@
module.exports = {
clearMocks: true,
moduleFileExtensions: ['js', 'ts'],
testMatch: ['**/*.test.ts'],
moduleFileExtensions: ["js", "ts"],
testMatch: ["**/*.test.ts"],
transform: {
'^.+\\.ts$': 'ts-jest'
"^.+\\.ts$": "ts-jest",
},
verbose: true,
modulePaths: [
"<rootDir>/src/"
],
}
modulePaths: ["<rootDir>/src/"],
};

3384
package-lock.json generated
View file

File diff suppressed because it is too large Load diff

11
package.json
View file

@ -17,12 +17,11 @@
"scripts": {
"prepublishOnly": "npm run build",
"build": "tsc",
"format": "prettier --write **/**.ts",
"format-check": "prettier --check **/**.ts",
"lint": "eslint src/**/*.ts",
"format": "prettier --write .",
"format-check": "prettier --check .",
"package": "ncc build --source-map --license licenses.txt",
"test": "jest --runInBand --config ./jest.config.js",
"all": "npm run build && npm run format && npm run lint && npm run package && npm test"
"all": "npm run build && npm run format-check && npm run package && npm test"
},
"repository": {
"type": "git",
@ -49,11 +48,7 @@
},
"devDependencies": {
"@types/node": "^22.19.7",
"@typescript-eslint/parser": "^6.21.0",
"@vercel/ncc": "^0.38.4",
"eslint": "^8.57.1",
"eslint-plugin-github": "^4.10.2",
"eslint-plugin-jest": "^27.9.0",
"jest": "^30.2.0",
"js-yaml": "^4.1.1",
"prettier": "^3.8.0",

47
src/formatting/BranchVersioningTagFormatter.ts
View file

@ -1,18 +1,16 @@
import { ActionConfig } from '../ActionConfig';
import { DefaultTagFormatter } from './DefaultTagFormatter';
import { ActionConfig } from "../ActionConfig";
import { DefaultTagFormatter } from "./DefaultTagFormatter";
/** Default tag formatter which allows a prefix to be specified */
export class BranchVersioningTagFormatter extends DefaultTagFormatter {
private onVersionBranch: boolean;
private major: number;
private minor?: number;
private getRegex(pattern: string) {
if (/^\/.+\/[i]*$/.test(pattern)) {
const regexEnd = pattern.lastIndexOf('/');
const parsedFlags = pattern.slice(pattern.lastIndexOf('/') + 1);
const regexEnd = pattern.lastIndexOf("/");
const parsedFlags = pattern.slice(pattern.lastIndexOf("/") + 1);
return new RegExp(pattern.slice(1, regexEnd), parsedFlags);
}
return new RegExp(pattern);
@ -20,9 +18,10 @@ export class BranchVersioningTagFormatter extends DefaultTagFormatter {
constructor(config: ActionConfig, branchName: string) {
super(config);
const pattern = config.versionFromBranch === true ?
new RegExp("[0-9]+.[0-9]+$|[0-9]+$") :
this.getRegex(config.versionFromBranch as string);
const pattern =
config.versionFromBranch === true
? new RegExp("[0-9]+.[0-9]+$|[0-9]+$")
: this.getRegex(config.versionFromBranch as string);
const result = pattern.exec(branchName);
if (result === null) {
@ -40,23 +39,31 @@ export class BranchVersioningTagFormatter extends DefaultTagFormatter {
branchVersion = result[1];
break;
default:
throw new Error(`Unable to parse version from branch named '${branchName}' using pattern '${pattern}'`);
throw new Error(
`Unable to parse version from branch named '${branchName}' using pattern '${pattern}'`,
);
}
this.onVersionBranch = true;
const versionValues = branchVersion.split('.');
const versionValues = branchVersion.split(".");
if (versionValues.length > 2) {
throw new Error(`The version string '${branchVersion}' parsed from branch '${branchName}' is invalid. It must be in the format 'major.minor' or 'major'`);
throw new Error(
`The version string '${branchVersion}' parsed from branch '${branchName}' is invalid. It must be in the format 'major.minor' or 'major'`,
);
}
this.major = parseInt(versionValues[0]);
if (isNaN(this.major)) {
throw new Error(`The major version '${versionValues[0]}' parsed from branch '${branchName}' is invalid. It must be a number.`);
throw new Error(
`The major version '${versionValues[0]}' parsed from branch '${branchName}' is invalid. It must be a number.`,
);
}
if (versionValues.length > 1) {
this.minor = parseInt(versionValues[1]);
if (isNaN(this.minor)) {
throw new Error(`The minor version '${versionValues[1]}' parsed from branch '${branchName}' is invalid. It must be a number.`);
throw new Error(
`The minor version '${versionValues[1]}' parsed from branch '${branchName}' is invalid. It must be a number.`,
);
}
}
}
@ -67,11 +74,17 @@ export class BranchVersioningTagFormatter extends DefaultTagFormatter {
return pattern;
}
if(this.minor === undefined) {
return pattern.replace('*[0-9].*[0-9].*[0-9]', `${this.major}.*[0-9].*[0-9]`);
if (this.minor === undefined) {
return pattern.replace(
"*[0-9].*[0-9].*[0-9]",
`${this.major}.*[0-9].*[0-9]`,
);
}
return pattern.replace('*[0-9].*[0-9].*[0-9]', `${this.major}.${this.minor}.*[0-9]`);
return pattern.replace(
"*[0-9].*[0-9].*[0-9]",
`${this.major}.${this.minor}.*[0-9]`,
);
}
override IsValid(tag: string): boolean {

9
src/formatting/CsvUserFormatter.ts
View file

@ -1,14 +1,13 @@
import { ActionConfig } from '../ActionConfig';
import { UserInfo } from '../providers/UserInfo';
import { UserFormatter } from './UserFormatter';
import { ActionConfig } from "../ActionConfig";
import { UserInfo } from "../providers/UserInfo";
import { UserFormatter } from "./UserFormatter";
export class CsvUserFormatter implements UserFormatter {
constructor(config: ActionConfig) {
// placeholder for consistency with other formatters
}
public Format(type: string, users: UserInfo[]): string {
return users.map(user => `${user.name} <${user.email}>`).join(', ');
return users.map((user) => `${user.name} <${user.email}>`).join(", ");
}
}

31
src/formatting/DefaultTagFormatter.ts
View file

@ -1,10 +1,9 @@
import { TagFormatter } from './TagFormatter';
import { TagFormatter } from "./TagFormatter";
import { VersionInformation } from "../providers/VersionInformation";
import { ActionConfig } from '../ActionConfig';
import { ActionConfig } from "../ActionConfig";
/** Default tag formatter which allows a prefix to be specified */
export class DefaultTagFormatter implements TagFormatter {
private tagPrefix: string;
private namespace: string;
private namespaceSeparator: string;
@ -12,7 +11,7 @@ export class DefaultTagFormatter implements TagFormatter {
constructor(config: ActionConfig) {
this.namespace = config.namespace;
this.tagPrefix = config.tagPrefix;
this.namespaceSeparator = '-'; // maybe make configurable in the future
this.namespaceSeparator = "-"; // maybe make configurable in the future
}
public Format(versionInfo: VersionInformation): string {
@ -26,7 +25,6 @@ export class DefaultTagFormatter implements TagFormatter {
}
public GetPattern(): string {
if (this.namespace) {
return `${this.tagPrefix}*[0-9].*[0-9].*[0-9]${this.namespaceSeparator}${this.namespace}`;
}
@ -35,24 +33,23 @@ export class DefaultTagFormatter implements TagFormatter {
}
public Parse(tag: string): [major: number, minor: number, patch: number] {
if(tag === '') {
if (tag === "") {
return [0, 0, 0];
}
let tagParts = tag
.replace(this.tagPrefix, '<--!PREFIX!-->')
.replace(this.namespace, '<--!NAMESPACE!-->')
.split('/');
.replace(this.tagPrefix, "<--!PREFIX!-->")
.replace(this.namespace, "<--!NAMESPACE!-->")
.split("/");
const stripedTag = tagParts[tagParts.length - 1]
.replace('<--!PREFIX!-->', this.tagPrefix)
.replace('<--!NAMESPACE!-->', this.namespace);
.replace("<--!PREFIX!-->", this.tagPrefix)
.replace("<--!NAMESPACE!-->", this.namespace);
let versionValues = stripedTag
.substring(this.tagPrefix.length)
.slice(0, this.namespace === '' ? 999 : -(this.namespace.length + 1))
.split('.');
.slice(0, this.namespace === "" ? 999 : -(this.namespace.length + 1))
.split(".");
let major = parseInt(versionValues[0]);
let minor = versionValues.length > 1 ? parseInt(versionValues[1]) : 0;
@ -66,13 +63,15 @@ export class DefaultTagFormatter implements TagFormatter {
}
public IsValid(tag: string): boolean {
const regexEscape = (literal: string) => literal.replace(/\W/g, '\\$&');
const regexEscape = (literal: string) => literal.replace(/\W/g, "\\$&");
const tagPrefix = regexEscape(this.tagPrefix);
const namespaceSeparator = regexEscape(this.namespaceSeparator);
const namespace = regexEscape(this.namespace);
if (this.namespace) {
return new RegExp(`^${tagPrefix}[0-9]+\\.[0-9]+\\.[0-9]+${namespaceSeparator}${namespace}$`).test(tag);
return new RegExp(
`^${tagPrefix}[0-9]+\\.[0-9]+\\.[0-9]+${namespaceSeparator}${namespace}$`,
).test(tag);
}
return new RegExp(`^${tagPrefix}[0-9]+\\.[0-9]+\\.[0-9]+$`).test(tag);

13
src/formatting/DefaultVersionFormatter.ts
View file

@ -1,9 +1,8 @@
import { VersionFormatter } from './VersionFormatter';
import { VersionFormatter } from "./VersionFormatter";
import { VersionInformation } from "../providers/VersionInformation";
import { ActionConfig } from '../ActionConfig';
import { ActionConfig } from "../ActionConfig";
export class DefaultVersionFormatter implements VersionFormatter {
private formatString: string;
constructor(config: ActionConfig) {
@ -12,9 +11,9 @@ export class DefaultVersionFormatter implements VersionFormatter {
public Format(versionInfo: VersionInformation): string {
return this.formatString
.replace('${major}', versionInfo.major.toString())
.replace('${minor}', versionInfo.minor.toString())
.replace('${patch}', versionInfo.patch.toString())
.replace('${increment}', versionInfo.increment.toString());
.replace("${major}", versionInfo.major.toString())
.replace("${minor}", versionInfo.minor.toString())
.replace("${patch}", versionInfo.patch.toString())
.replace("${increment}", versionInfo.increment.toString());
}
}

10
src/formatting/JsonUserFormatter.ts
View file

@ -1,13 +1,13 @@
import { ActionConfig } from '../ActionConfig';
import { UserInfo } from '../providers/UserInfo';
import { UserFormatter } from './UserFormatter';
import { ActionConfig } from "../ActionConfig";
import { UserInfo } from "../providers/UserInfo";
import { UserFormatter } from "./UserFormatter";
export class JsonUserFormatter implements UserFormatter {
constructor(config: ActionConfig) {
// placeholder for consistency with other formatters
}
public Format(type: string, users: UserInfo[]): string {
let result: any = users.map(u => ({ name: u.name, email: u.email }));
return JSON.stringify(result).replace('\n', '');
let result: any = users.map((u) => ({ name: u.name, email: u.email }));
return JSON.stringify(result).replace("\n", "");
}
}

47
src/providers/BumpAlwaysVersionClassifier.ts
View file

@ -7,7 +7,6 @@ import { VersionClassification } from "./VersionClassification";
import { VersionType } from "./VersionType";
export class BumpAlwaysVersionClassifier extends DefaultVersionClassifier {
protected patchPattern: (commit: CommitInfo) => boolean;
protected enablePrereleaseMode: boolean;
@ -15,15 +14,28 @@ export class BumpAlwaysVersionClassifier extends DefaultVersionClassifier {
super(config);
this.enablePrereleaseMode = config.enablePrereleaseMode;
this.patchPattern = !config.bumpEachCommitPatchPattern ?
_ => true :
this.parsePattern(config.bumpEachCommitPatchPattern, "", config.searchCommitBody);
this.patchPattern = !config.bumpEachCommitPatchPattern
? (_) => true
: this.parsePattern(
config.bumpEachCommitPatchPattern,
"",
config.searchCommitBody,
);
}
public override async ClassifyAsync(lastRelease: ReleaseInformation, commitSet: CommitInfoSet): Promise<VersionClassification> {
public override async ClassifyAsync(
lastRelease: ReleaseInformation,
commitSet: CommitInfoSet,
): Promise<VersionClassification> {
if (lastRelease.currentPatch !== null) {
return new VersionClassification(VersionType.None, 0, false, <number>lastRelease.currentMajor, <number>lastRelease.currentMinor, <number>lastRelease.currentPatch);
return new VersionClassification(
VersionType.None,
0,
false,
<number>lastRelease.currentMajor,
<number>lastRelease.currentMinor,
<number>lastRelease.currentPatch,
);
}
let { major, minor, patch } = lastRelease;
@ -35,19 +47,22 @@ export class BumpAlwaysVersionClassifier extends DefaultVersionClassifier {
}
for (let commit of commitSet.commits.reverse()) {
if (this.majorPattern(commit)) {
type = VersionType.Major;
} else if (this.minorPattern(commit)) {
type = VersionType.Minor;
} else if (this.patchPattern(commit) ||
(major === 0 && minor === 0 && patch === 0 && commitSet.commits.length > 0)) {
} else if (
this.patchPattern(commit) ||
(major === 0 &&
minor === 0 &&
patch === 0 &&
commitSet.commits.length > 0)
) {
type = VersionType.Patch;
} else {
type = VersionType.None;
}
if (this.enablePrereleaseMode && major === 0) {
switch (type) {
case VersionType.Major:
@ -85,9 +100,15 @@ export class BumpAlwaysVersionClassifier extends DefaultVersionClassifier {
break;
}
}
}
return new VersionClassification(type, increment, true, major, minor, patch);
return new VersionClassification(
type,
increment,
true,
major,
minor,
patch,
);
}
}

3
src/providers/CommitInfo.ts
View file

@ -23,5 +23,6 @@ export class CommitInfo {
public committer: string,
public committerEmail: string,
public committerDate: Date,
public tags: string[]) { }
public tags: string[],
) {}
}

4
src/providers/CommitInfoSet.ts
View file

@ -4,6 +4,6 @@ import { CommitInfo } from "./CommitInfo";
export class CommitInfoSet {
constructor(
public changed: boolean,
public commits: CommitInfo[]
){}
public commits: CommitInfo[],
) {}
}

67
src/providers/DefaultCommitsProvider.ts
View file

@ -5,60 +5,60 @@ import { CommitInfoSet } from "./CommitInfoSet";
import { CommitsProvider } from "./CommitsProvider";
export class DefaultCommitsProvider implements CommitsProvider {
private changePath: string;
constructor(config: ActionConfig) {
this.changePath = config.changePath;
}
async GetCommitsAsync(startHash: string, endHash: string): Promise<CommitInfoSet> {
const logSplitter = `@@@START_RECORD`
async GetCommitsAsync(
startHash: string,
endHash: string,
): Promise<CommitInfoSet> {
const logSplitter = `@@@START_RECORD`;
const formatPlaceholders = Object.entries({
hash: '%H',
subject: '%s',
body: '%b',
author: '%an',
authorEmail: '%ae',
authorDate: '%aI',
committer: '%cn',
committerEmail: '%ce',
committerDate: '%cI',
tags: '%d'
hash: "%H",
subject: "%s",
body: "%b",
author: "%an",
authorEmail: "%ae",
authorDate: "%aI",
committer: "%cn",
committerEmail: "%ce",
committerDate: "%cI",
tags: "%d",
});
const pretty = logSplitter + '%n' + formatPlaceholders
.map(x => `@@@${x[0]}%n${x[1]}`)
.join('%n');
const pretty =
logSplitter +
"%n" +
formatPlaceholders.map((x) => `@@@${x[0]}%n${x[1]}`).join("%n");
var logCommand = `git log --pretty="${pretty}" --author-date-order ${(startHash === '' ? endHash : `${startHash}..${endHash}`)}`;
var logCommand = `git log --pretty="${pretty}" --author-date-order ${startHash === "" ? endHash : `${startHash}..${endHash}`}`;
if (this.changePath !== '') {
if (this.changePath !== "") {
logCommand += ` -- ${this.changePath}`;
}
const log = await cmd(logCommand);
const entries = log
.split(logSplitter)
.slice(1);
const entries = log.split(logSplitter).slice(1);
const commits = entries.map(entry => {
const commits = entries.map((entry) => {
const fields: any = entry
.split(`@@@`)
.slice(1)
.reduce((acc: any, value: string) => {
const firstLine = value.indexOf('\n');
const firstLine = value.indexOf("\n");
const key = value.substring(0, firstLine);
acc[key] = value.substring(firstLine + 1).trim();
return acc;
}, {});
const tags = fields.tags
.split(',')
.split(",")
.map((v: string) => v.trim())
.filter((v: string) => v.startsWith('tags: '))
.filter((v: string) => v.startsWith("tags: "))
.map((v: string) => v.substring(5).trim());
return new CommitInfo(
@ -71,24 +71,27 @@ export class DefaultCommitsProvider implements CommitsProvider {
fields.committer,
fields.committerEmail,
new Date(fields.committerDate),
tags
tags,
);
});
// check for changes
let changed = true;
if (this.changePath !== '') {
if (startHash === '') {
const changedFiles = await cmd(`git log --name-only --oneline ${endHash} -- ${this.changePath}`);
if (this.changePath !== "") {
if (startHash === "") {
const changedFiles = await cmd(
`git log --name-only --oneline ${endHash} -- ${this.changePath}`,
);
changed = changedFiles.length > 0;
} else {
const changedFiles = await cmd(`git diff --name-only ${startHash}..${endHash} -- ${this.changePath}`);
const changedFiles = await cmd(
`git diff --name-only ${startHash}..${endHash} -- ${this.changePath}`,
);
changed = changedFiles.length > 0;
}
}
return new CommitInfoSet(changed, commits);
}
}

15
src/providers/DefaultCurrentCommitResolver.ts
View file

@ -2,9 +2,7 @@ import { ActionConfig } from "../ActionConfig";
import { cmd } from "../CommandRunner";
import { CurrentCommitResolver } from "./CurrentCommitResolver";
export class DefaultCurrentCommitResolver implements CurrentCommitResolver {
private branch: string;
constructor(config: ActionConfig) {
@ -12,21 +10,22 @@ export class DefaultCurrentCommitResolver implements CurrentCommitResolver {
}
public async ResolveAsync(): Promise<string> {
if (this.branch === 'HEAD') {
return (await cmd('git', 'rev-parse', 'HEAD')).trim();
if (this.branch === "HEAD") {
return (await cmd("git", "rev-parse", "HEAD")).trim();
}
return this.branch;
}
public async IsEmptyRepoAsync(): Promise<boolean> {
let lastCommitAll = (await cmd('git', 'rev-list', '-n1', '--all')).trim();
return lastCommitAll === '';
let lastCommitAll = (await cmd("git", "rev-list", "-n1", "--all")).trim();
return lastCommitAll === "";
}
public async ResolveBranchNameAsync(): Promise<string> {
const branchName =
this.branch == 'HEAD' ? await cmd('git', 'rev-parse', '--abbrev-ref', 'HEAD') : this.branch;
this.branch == "HEAD"
? await cmd("git", "rev-parse", "--abbrev-ref", "HEAD")
: this.branch;
return branchName.trim();
}

83
src/providers/DefaultLastReleaseResolver.ts
View file

@ -3,10 +3,9 @@ import { TagFormatter } from "../formatting/TagFormatter";
import { LastReleaseResolver } from "./LastReleaseResolver";
import { ReleaseInformation } from "./ReleaseInformation";
import { ActionConfig } from "../ActionConfig";
import * as core from '@actions/core';
import * as core from "@actions/core";
export class DefaultLastReleaseResolver implements LastReleaseResolver {
private changePath: string;
private useBranches: boolean;
@ -15,68 +14,90 @@ export class DefaultLastReleaseResolver implements LastReleaseResolver {
this.useBranches = config.useBranches;
}
async ResolveAsync(current: string, tagFormatter: TagFormatter): Promise<ReleaseInformation> {
async ResolveAsync(
current: string,
tagFormatter: TagFormatter,
): Promise<ReleaseInformation> {
const releasePattern = tagFormatter.GetPattern();
let currentTag = (await cmd(
`git tag --points-at ${current} ${releasePattern}`
)).trim();
let currentTag = (
await cmd(`git tag --points-at ${current} ${releasePattern}`)
).trim();
currentTag = tagFormatter.IsValid(currentTag) ? currentTag : '';
const isTagged = currentTag !== '';
currentTag = tagFormatter.IsValid(currentTag) ? currentTag : "";
const isTagged = currentTag !== "";
const [currentMajor, currentMinor, currentPatch] = currentTag ? tagFormatter.Parse(currentTag) : [null, null, null];
const [currentMajor, currentMinor, currentPatch] = currentTag
? tagFormatter.Parse(currentTag)
: [null, null, null];
let tagsCount = 0;
let tag = '';
let tag = "";
try {
const refPrefixPattern = this.useBranches ? 'refs/heads/' : 'refs/tags/';
const refPrefixPattern = this.useBranches ? "refs/heads/" : "refs/tags/";
if (currentTag) {
// If we already have the current branch tagged, we are checking for the previous one
// so that we will have an accurate increment (assuming the new tag is the expected one)
const command = `git for-each-ref --sort=-v:*refname --format=%(refname:short) --merged=${current} ${refPrefixPattern}${releasePattern}`;
const tags = (await cmd(command)).split('\n')
const tags = (await cmd(command)).split("\n");
tagsCount = tags.length;
tag = tags
.find(t => tagFormatter.IsValid(t) && t !== currentTag) || '';
tag =
tags.find((t) => tagFormatter.IsValid(t) && t !== currentTag) || "";
} else {
const command = `git for-each-ref --sort=-v:*refname --format=%(refname:short) --merged=${current} ${refPrefixPattern}${releasePattern}`;
const tags = (await cmd(command)).split('\n')
const tags = (await cmd(command)).split("\n");
tagsCount = tags.length;
tag = tags
.find(t => tagFormatter.IsValid(t)) || '';
tag = tags.find((t) => tagFormatter.IsValid(t)) || "";
}
tag = tag.trim();
}
catch (err) {
tag = '';
} catch (err) {
tag = "";
}
if (tag === '') {
if (await cmd('git', 'remote') !== '') {
if (tag === "") {
if ((await cmd("git", "remote")) !== "") {
// Since there is no remote, we assume that there are no other tags to pull. In
// practice this isn't likely to happen, but it keeps the test output from being
// polluted with a bunch of warnings.
if (tagsCount > 0) {
core.warning(`None of the ${tagsCount} tags(s) found were valid version tags for the present configuration. If this is unexpected, check to ensure that the configuration is correct and matches the tag format you are using. If you have not yet tagged this repo with a version tag, this can be ignored.`);
core.warning(
`None of the ${tagsCount} tags(s) found were valid version tags for the present configuration. If this is unexpected, check to ensure that the configuration is correct and matches the tag format you are using. If you have not yet tagged this repo with a version tag, this can be ignored.`,
);
} else {
core.warning('No tags are present for this repository. If this is unexpected, check to ensure that tags have been pulled from the remote. If you have not yet tagged this repo with a version tag, this can be ignored.');
core.warning(
"No tags are present for this repository. If this is unexpected, check to ensure that tags have been pulled from the remote. If you have not yet tagged this repo with a version tag, this can be ignored.",
);
}
}
const [major, minor, patch] = tagFormatter.Parse('');
const [major, minor, patch] = tagFormatter.Parse("");
// no release tags yet, use the initial commit as the root
return new ReleaseInformation(major, minor, patch, '', currentMajor, currentMinor, currentPatch, isTagged);
return new ReleaseInformation(
major,
minor,
patch,
"",
currentMajor,
currentMinor,
currentPatch,
isTagged,
);
}
// parse the version tag
const [major, minor, patch] = tagFormatter.Parse(tag);
const root = await cmd('git', `merge-base`, tag, current);
return new ReleaseInformation(major, minor, patch, root.trim(), currentMajor, currentMinor, currentPatch, isTagged);
const root = await cmd("git", `merge-base`, tag, current);
return new ReleaseInformation(
major,
minor,
patch,
root.trim(),
currentMajor,
currentMinor,
currentPatch,
isTagged,
);
}
}

45
src/providers/DefaultVersionClassifier.test.ts
View file

@ -5,14 +5,47 @@ import { CommitInfoSet } from "./CommitInfoSet";
import { DefaultVersionClassifier } from "./DefaultVersionClassifier";
import { ReleaseInformation } from "./ReleaseInformation";
test('Regular expressions can be used as minor tag direct', async () => {
test("Regular expressions can be used as minor tag direct", async () => {
const classifier = new DefaultVersionClassifier({
...new ActionConfig(),
...{ tagPrefix: "", minorPattern: "/S[a-z]+Value/" },
});
const classifier = new DefaultVersionClassifier({ ...new ActionConfig(), ...{ tagPrefix: '', minorPattern: '/S[a-z]+Value/' }});
const releaseInfo =new ReleaseInformation(0,0,1,"",null,null,null,false);
const releaseInfo = new ReleaseInformation(
0,
0,
1,
"",
null,
null,
null,
false,
);
const commitSet = new CommitInfoSet(false, [
new CommitInfo("", "Second Commit SomeValue", "", "","", new Date(), "", "", new Date(), []),
new CommitInfo("", "Initial Commit", "", "","", new Date(), "", "", new Date(), []),
new CommitInfo(
"",
"Second Commit SomeValue",
"",
"",
"",
new Date(),
"",
"",
new Date(),
[],
),
new CommitInfo(
"",
"Initial Commit",
"",
"",
"",
new Date(),
"",
"",
new Date(),
[],
),
]);
const result = await classifier.ClassifyAsync(releaseInfo, commitSet);

133
src/providers/DefaultVersionClassifier.ts
View file

@ -7,45 +7,72 @@ import { VersionClassifier } from "./VersionClassifier";
import { VersionType } from "./VersionType";
export class DefaultVersionClassifier implements VersionClassifier {
protected majorPattern: (commit: CommitInfo) => boolean;
protected minorPattern: (commit: CommitInfo) => boolean;
protected enablePrereleaseMode: boolean;
constructor(config: ActionConfig) {
const searchBody = config.searchCommitBody;
this.majorPattern = this.parsePattern(config.majorPattern, config.majorFlags, searchBody);
this.minorPattern = this.parsePattern(config.minorPattern, config.minorFlags, searchBody);
this.majorPattern = this.parsePattern(
config.majorPattern,
config.majorFlags,
searchBody,
);
this.minorPattern = this.parsePattern(
config.minorPattern,
config.minorFlags,
searchBody,
);
this.enablePrereleaseMode = config.enablePrereleaseMode;
}
protected parsePattern(pattern: string, flags: string, searchBody: boolean): (pattern: CommitInfo) => boolean {
protected parsePattern(
pattern: string,
flags: string,
searchBody: boolean,
): (pattern: CommitInfo) => boolean {
if (/^\/.+\/[i]*$/.test(pattern)) {
const regexEnd = pattern.lastIndexOf('/');
const parsedFlags = pattern.slice(pattern.lastIndexOf('/') + 1);
const regex = new RegExp(pattern.slice(1, regexEnd), parsedFlags || flags);
return searchBody ?
(commit: CommitInfo) => regex.test(commit.subject) || regex.test(commit.body) :
(commit: CommitInfo) => regex.test(commit.subject);
const regexEnd = pattern.lastIndexOf("/");
const parsedFlags = pattern.slice(pattern.lastIndexOf("/") + 1);
const regex = new RegExp(
pattern.slice(1, regexEnd),
parsedFlags || flags,
);
return searchBody
? (commit: CommitInfo) =>
regex.test(commit.subject) || regex.test(commit.body)
: (commit: CommitInfo) => regex.test(commit.subject);
} else {
const matchString = pattern;
return searchBody ?
(commit: CommitInfo) => commit.subject.includes(matchString) || commit.body.includes(matchString) :
(commit: CommitInfo) => commit.subject.includes(matchString);
return searchBody
? (commit: CommitInfo) =>
commit.subject.includes(matchString) ||
commit.body.includes(matchString)
: (commit: CommitInfo) => commit.subject.includes(matchString);
}
}
protected getNextVersion(current: ReleaseInformation, type: VersionType): ({ major: number, minor: number, patch: number }) {
protected getNextVersion(
current: ReleaseInformation,
type: VersionType,
): { major: number; minor: number; patch: number } {
if (this.enablePrereleaseMode && current.major === 0) {
switch (type) {
case VersionType.Major:
return { major: current.major, minor: current.minor + 1, patch: 0 };
case VersionType.Minor:
case VersionType.Patch:
return { major: current.major, minor: current.minor, patch: current.patch + 1 };
return {
major: current.major,
minor: current.minor,
patch: current.patch + 1,
};
case VersionType.None:
return { major: current.major, minor: current.minor, patch: current.patch };
return {
major: current.major,
minor: current.minor,
patch: current.patch,
};
default:
throw new Error(`Unknown change type: ${type}`);
}
@ -57,24 +84,44 @@ export class DefaultVersionClassifier implements VersionClassifier {
case VersionType.Minor:
return { major: current.major, minor: current.minor + 1, patch: 0 };
case VersionType.Patch:
return { major: current.major, minor: current.minor, patch: current.patch + 1 };
return {
major: current.major,
minor: current.minor,
patch: current.patch + 1,
};
case VersionType.None:
return { major: current.major, minor: current.minor, patch: current.patch };
return {
major: current.major,
minor: current.minor,
patch: current.patch,
};
default:
throw new Error(`Unknown change type: ${type}`);
}
}
private resolveCommitType(commitsSet: CommitInfoSet): ({ type: VersionType, increment: number, changed: boolean }) {
private resolveCommitType(commitsSet: CommitInfoSet): {
type: VersionType;
increment: number;
changed: boolean;
} {
if (commitsSet.commits.length === 0) {
return { type: VersionType.None, increment: 0, changed: commitsSet.changed };
return {
type: VersionType.None,
increment: 0,
changed: commitsSet.changed,
};
}
const commits = commitsSet.commits.reverse();
let index = 1;
for (let commit of commits) {
if (this.majorPattern(commit)) {
return { type: VersionType.Major, increment: commits.length - index, changed: commitsSet.changed };
return {
type: VersionType.Major,
increment: commits.length - index,
changed: commitsSet.changed,
};
}
index++;
}
@ -82,16 +129,26 @@ export class DefaultVersionClassifier implements VersionClassifier {
index = 1;
for (let commit of commits) {
if (this.minorPattern(commit)) {
return { type: VersionType.Minor, increment: commits.length - index, changed: commitsSet.changed };
return {
type: VersionType.Minor,
increment: commits.length - index,
changed: commitsSet.changed,
};
}
index++;
}
return { type: VersionType.Patch, increment: commitsSet.commits.length - 1, changed: true };
return {
type: VersionType.Patch,
increment: commitsSet.commits.length - 1,
changed: true,
};
}
public async ClassifyAsync(lastRelease: ReleaseInformation, commitSet: CommitInfoSet): Promise<VersionClassification> {
public async ClassifyAsync(
lastRelease: ReleaseInformation,
commitSet: CommitInfoSet,
): Promise<VersionClassification> {
const { type, increment, changed } = this.resolveCommitType(commitSet);
const { major, minor, patch } = this.getNextVersion(lastRelease, type);
@ -106,12 +163,28 @@ export class DefaultVersionClassifier implements VersionClassifier {
// - commit 3 was tagged v2.0.0 - v2.0.0+0
// - commit 4 - v2.0.1+0
const versionsMatch = lastRelease.currentMajor === major && lastRelease.currentMinor === minor && lastRelease.currentPatch === patch;
const versionsMatch =
lastRelease.currentMajor === major &&
lastRelease.currentMinor === minor &&
lastRelease.currentPatch === patch;
const currentIncrement = versionsMatch ? increment : 0;
return new VersionClassification(VersionType.None, currentIncrement, false, <number>lastRelease.currentMajor, <number>lastRelease.currentMinor, <number>lastRelease.currentPatch);
return new VersionClassification(
VersionType.None,
currentIncrement,
false,
<number>lastRelease.currentMajor,
<number>lastRelease.currentMinor,
<number>lastRelease.currentPatch,
);
}
return new VersionClassification(type, increment, changed, major, minor, patch);
return new VersionClassification(
type,
increment,
changed,
major,
minor,
patch,
);
}
}

9
src/providers/LastReleaseResolver.ts
View file

@ -1,6 +1,9 @@
import { TagFormatter } from '../formatting/TagFormatter';
import { ReleaseInformation } from './ReleaseInformation';
import { TagFormatter } from "../formatting/TagFormatter";
import { ReleaseInformation } from "./ReleaseInformation";
export interface LastReleaseResolver {
ResolveAsync(current: string, tagFormatter: TagFormatter): Promise<ReleaseInformation>;
ResolveAsync(
current: string,
tagFormatter: TagFormatter,
): Promise<ReleaseInformation>;
}

3
src/providers/ReleaseInformation.ts
View file

@ -19,5 +19,6 @@ export class ReleaseInformation {
public currentMajor: number | null,
public currentMinor: number | null,
public currentPatch: number | null,
public isTagged: boolean,) { }
public isTagged: boolean,
) {}
}

4
src/providers/UserInfo.ts
View file

@ -1,4 +1,3 @@
/** Represents information about a user (e.g. committer, author, tagger) */
export class UserInfo {
/**
@ -10,5 +9,6 @@ export class UserInfo {
constructor(
public name: string,
public email: string,
public commits: number) { }
public commits: number,
) {}
}

5
src/providers/VersionClassification.ts
View file

@ -1,4 +1,4 @@
import { VersionType } from './VersionType';
import { VersionType } from "./VersionType";
/** The result of a version classification */
export class VersionClassification {
@ -17,5 +17,6 @@ export class VersionClassification {
public changed: boolean,
public major: number,
public minor: number,
public patch: number) { }
public patch: number,
) {}
}

5
src/providers/VersionClassifier.ts
View file

@ -13,5 +13,8 @@ export interface VersionClassifier {
* @param commitSet - The commits to classify, ordered from most recent to oldest
* @returns - The version classification
*/
ClassifyAsync(lastRelease: ReleaseInformation, commitSet: CommitInfoSet): Promise<VersionClassification>;
ClassifyAsync(
lastRelease: ReleaseInformation,
commitSet: CommitInfoSet,
): Promise<VersionClassification>;
}

3
src/providers/VersionInformation.ts
View file

@ -25,5 +25,6 @@ export class VersionInformation {
public type: VersionType,
public commits: CommitInfo[],
public changed: boolean,
public isTagged: boolean) { }
public isTagged: boolean,
) {}
}

9
src/providers/VersionType.ts
View file

@ -1,12 +1,11 @@
/** Indicates the type of change a particular version change represents */
export enum VersionType {
/** Indicates a major version change */
Major = 'Major',
Major = "Major",
/** Indicates a minor version change */
Minor = 'Minor',
Minor = "Minor",
/** Indicates a patch version change */
Patch = 'Patch',
Patch = "Patch",
/** Indicates no change--generally this means that the current commit is already tagged with a version */
None = 'None'
None = "None",
}

14
tsconfig.json
View file

@ -1,12 +1,12 @@
{
"compilerOptions": {
"target": "es6", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
"module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
"outDir": "./lib", /* Redirect output structure to the directory. */
"rootDir": "./src", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
"strict": true, /* Enable all strict type-checking options. */
"noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
"target": "es6" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */,
"module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
"outDir": "./lib" /* Redirect output structure to the directory. */,
"rootDir": "./src" /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */,
"strict": true /* Enable all strict type-checking options. */,
"noImplicitAny": true /* Raise error on expressions and declarations with an implied 'any' type. */,
"esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
},
"exclude": ["node_modules", "**/*.test.ts"]
}
}