chore(deps): upgrade dependencies and drop ESLint

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

View file

@ -1,104 +1,117 @@
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 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);
return new RegExp(pattern.slice(1, regexEnd), parsedFlags);
}
return new RegExp(pattern);
}
private getRegex(pattern: string) {
if (/^\/.+\/[i]*$/.test(pattern)) {
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: 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 result = pattern.exec(branchName);
if (result === null) {
this.major = NaN;
this.onVersionBranch = false;
return;
}
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 result = pattern.exec(branchName);
if (result === null) {
this.major = NaN;
this.onVersionBranch = false;
return;
}
let branchVersion: string;
switch (result?.length) {
case 1:
branchVersion = result[0];
break;
case 2:
branchVersion = result[1];
break;
default:
throw new Error(`Unable to parse version from branch named '${branchName}' using pattern '${pattern}'`);
}
this.onVersionBranch = true;
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'`);
}
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.`);
}
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.`);
}
}
let branchVersion: string;
switch (result?.length) {
case 1:
branchVersion = result[0];
break;
case 2:
branchVersion = result[1];
break;
default:
throw new Error(
`Unable to parse version from branch named '${branchName}' using pattern '${pattern}'`,
);
}
public override GetPattern(): string {
let pattern = super.GetPattern();
if (!this.onVersionBranch) {
return pattern;
}
this.onVersionBranch = true;
if(this.minor === undefined) {
return pattern.replace('*[0-9].*[0-9].*[0-9]', `${this.major}.*[0-9].*[0-9]`);
}
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'`,
);
}
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.`,
);
}
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.`,
);
}
}
}
return pattern.replace('*[0-9].*[0-9].*[0-9]', `${this.major}.${this.minor}.*[0-9]`);
public override GetPattern(): string {
let pattern = super.GetPattern();
if (!this.onVersionBranch) {
return pattern;
}
override IsValid(tag: string): boolean {
if (!this.onVersionBranch) {
return super.IsValid(tag);
}
if (!super.IsValid(tag)) {
return false;
}
const parsed = super.Parse(tag);
if (parsed[0] !== this.major) {
return false;
}
if (this.minor !== undefined && parsed[1] !== this.minor) {
return false;
}
return true;
if (this.minor === undefined) {
return pattern.replace(
"*[0-9].*[0-9].*[0-9]",
`${this.major}.*[0-9].*[0-9]`,
);
}
override Parse(tag: string): [major: number, minor: number, patch: number] {
if (!this.onVersionBranch) {
return super.Parse(tag);
}
return pattern.replace(
"*[0-9].*[0-9].*[0-9]",
`${this.major}.${this.minor}.*[0-9]`,
);
}
const parsed = super.Parse(tag);
return [this.major, this.minor || parsed[1], parsed[2]];
override IsValid(tag: string): boolean {
if (!this.onVersionBranch) {
return super.IsValid(tag);
}
}
if (!super.IsValid(tag)) {
return false;
}
const parsed = super.Parse(tag);
if (parsed[0] !== this.major) {
return false;
}
if (this.minor !== undefined && parsed[1] !== this.minor) {
return false;
}
return true;
}
override Parse(tag: string): [major: number, minor: number, patch: number] {
if (!this.onVersionBranch) {
return super.Parse(tag);
}
const parsed = super.Parse(tag);
return [this.major, this.minor || parsed[1], parsed[2]];
}
}

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(", ");
}
}

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);

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());
}
}

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', '');
}
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", "");
}
}

View file

@ -7,87 +7,108 @@ import { VersionClassification } from "./VersionClassification";
import { VersionType } from "./VersionType";
export class BumpAlwaysVersionClassifier extends DefaultVersionClassifier {
protected patchPattern: (commit: CommitInfo) => boolean;
protected enablePrereleaseMode: boolean;
protected patchPattern: (commit: CommitInfo) => boolean;
protected enablePrereleaseMode: boolean;
constructor(config: ActionConfig) {
super(config);
constructor(config: ActionConfig) {
super(config);
this.enablePrereleaseMode = config.enablePrereleaseMode;
this.patchPattern = !config.bumpEachCommitPatchPattern
? (_) => true
: this.parsePattern(
config.bumpEachCommitPatchPattern,
"",
config.searchCommitBody,
);
}
this.enablePrereleaseMode = config.enablePrereleaseMode;
this.patchPattern = !config.bumpEachCommitPatchPattern ?
_ => true :
this.parsePattern(config.bumpEachCommitPatchPattern, "", config.searchCommitBody);
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,
);
}
public override async ClassifyAsync(lastRelease: ReleaseInformation, commitSet: CommitInfoSet): Promise<VersionClassification> {
let { major, minor, patch } = lastRelease;
let type = VersionType.None;
let increment = 0;
if (lastRelease.currentPatch !== null) {
return new VersionClassification(VersionType.None, 0, false, <number>lastRelease.currentMajor, <number>lastRelease.currentMinor, <number>lastRelease.currentPatch);
}
let { major, minor, patch } = lastRelease;
let type = VersionType.None;
let increment = 0;
if (commitSet.commits.length === 0) {
return new VersionClassification(type, 0, false, major, minor, patch);
}
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)) {
type = VersionType.Patch;
} else {
type = VersionType.None;
}
if (this.enablePrereleaseMode && major === 0) {
switch (type) {
case VersionType.Major:
case VersionType.Minor:
minor += 1;
patch = 0;
increment = 0;
break;
case VersionType.Patch:
patch += 1;
increment = 0;
break;
default:
increment++;
break;
}
} else {
switch (type) {
case VersionType.Major:
major += 1;
minor = 0;
patch = 0;
increment = 0;
break;
case VersionType.Minor:
minor += 1;
patch = 0;
break;
case VersionType.Patch:
patch += 1;
increment = 0;
break;
default:
increment++;
break;
}
}
}
return new VersionClassification(type, increment, true, major, minor, patch);
if (commitSet.commits.length === 0) {
return new VersionClassification(type, 0, false, major, minor, patch);
}
}
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)
) {
type = VersionType.Patch;
} else {
type = VersionType.None;
}
if (this.enablePrereleaseMode && major === 0) {
switch (type) {
case VersionType.Major:
case VersionType.Minor:
minor += 1;
patch = 0;
increment = 0;
break;
case VersionType.Patch:
patch += 1;
increment = 0;
break;
default:
increment++;
break;
}
} else {
switch (type) {
case VersionType.Major:
major += 1;
minor = 0;
patch = 0;
increment = 0;
break;
case VersionType.Minor:
minor += 1;
patch = 0;
break;
case VersionType.Patch:
patch += 1;
increment = 0;
break;
default:
increment++;
break;
}
}
}
return new VersionClassification(
type,
increment,
true,
major,
minor,
patch,
);
}
}

View file

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

View file

@ -2,8 +2,8 @@ import { CommitInfo } from "./CommitInfo";
/** Represents information about a set of commits */
export class CommitInfoSet {
constructor(
public changed: boolean,
public commits: CommitInfo[]
){}
}
constructor(
public changed: boolean,
public commits: CommitInfo[],
) {}
}

View file

@ -5,90 +5,93 @@ import { CommitInfoSet } from "./CommitInfoSet";
import { CommitsProvider } from "./CommitsProvider";
export class DefaultCommitsProvider implements CommitsProvider {
private changePath: string;
private changePath: string;
constructor(config: ActionConfig) {
this.changePath = config.changePath;
}
constructor(config: ActionConfig) {
this.changePath = config.changePath;
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",
});
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}`;
}
async GetCommitsAsync(startHash: string, endHash: string): Promise<CommitInfoSet> {
const log = await cmd(logCommand);
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'
});
const entries = log.split(logSplitter).slice(1);
const pretty = logSplitter + '%n' + formatPlaceholders
.map(x => `@@@${x[0]}%n${x[1]}`)
.join('%n');
const commits = entries.map((entry) => {
const fields: any = entry
.split(`@@@`)
.slice(1)
.reduce((acc: any, value: string) => {
const firstLine = value.indexOf("\n");
const key = value.substring(0, firstLine);
acc[key] = value.substring(firstLine + 1).trim();
return acc;
}, {});
var logCommand = `git log --pretty="${pretty}" --author-date-order ${(startHash === '' ? endHash : `${startHash}..${endHash}`)}`;
const tags = fields.tags
.split(",")
.map((v: string) => v.trim())
.filter((v: string) => v.startsWith("tags: "))
.map((v: string) => v.substring(5).trim());
if (this.changePath !== '') {
logCommand += ` -- ${this.changePath}`;
}
return new CommitInfo(
fields.hash,
fields.subject,
fields.body,
fields.author,
fields.authorEmail,
new Date(fields.authorDate),
fields.committer,
fields.committerEmail,
new Date(fields.committerDate),
tags,
);
});
const log = await cmd(logCommand);
const entries = log
.split(logSplitter)
.slice(1);
const commits = entries.map(entry => {
const fields: any = entry
.split(`@@@`)
.slice(1)
.reduce((acc: any, value: string) => {
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(',')
.map((v: string) => v.trim())
.filter((v: string) => v.startsWith('tags: '))
.map((v: string) => v.substring(5).trim());
return new 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 === '') {
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}`);
changed = changedFiles.length > 0;
}
}
return new CommitInfoSet(changed, commits);
// check for changes
let changed = true;
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}`,
);
changed = changedFiles.length > 0;
}
}
}
return new CommitInfoSet(changed, commits);
}
}

View file

@ -2,32 +2,31 @@ import { ActionConfig } from "../ActionConfig";
import { cmd } from "../CommandRunner";
import { CurrentCommitResolver } from "./CurrentCommitResolver";
export class DefaultCurrentCommitResolver implements CurrentCommitResolver {
private branch: string;
private branch: string;
constructor(config: ActionConfig) {
this.branch = config.branch;
}
constructor(config: ActionConfig) {
this.branch = config.branch;
public async ResolveAsync(): Promise<string> {
if (this.branch === "HEAD") {
return (await cmd("git", "rev-parse", "HEAD")).trim();
}
return this.branch;
}
public async ResolveAsync(): Promise<string> {
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 === "";
}
public async IsEmptyRepoAsync(): Promise<boolean> {
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;
public async ResolveBranchNameAsync(): Promise<string> {
const branchName =
this.branch == 'HEAD' ? await cmd('git', 'rev-parse', '--abbrev-ref', 'HEAD') : this.branch;
return branchName.trim();
}
}
return branchName.trim();
}
}

View file

@ -3,80 +3,101 @@ 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;
private changePath: string;
private useBranches: boolean;
constructor(config: ActionConfig) {
this.changePath = config.changePath;
this.useBranches = config.useBranches;
}
constructor(config: ActionConfig) {
this.changePath = config.changePath;
this.useBranches = config.useBranches;
async ResolveAsync(
current: string,
tagFormatter: TagFormatter,
): Promise<ReleaseInformation> {
const releasePattern = tagFormatter.GetPattern();
let currentTag = (
await 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];
let tagsCount = 0;
let tag = "";
try {
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");
tagsCount = tags.length;
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");
tagsCount = tags.length;
tag = tags.find((t) => tagFormatter.IsValid(t)) || "";
}
tag = tag.trim();
} catch (err) {
tag = "";
}
async ResolveAsync(current: string, tagFormatter: TagFormatter): Promise<ReleaseInformation> {
const releasePattern = tagFormatter.GetPattern();
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.
let currentTag = (await 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];
let tagsCount = 0;
let tag = '';
try {
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')
tagsCount = tags.length;
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')
tagsCount = tags.length;
tag = tags
.find(t => tagFormatter.IsValid(t)) || '';
}
tag = tag.trim();
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.`,
);
} 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.",
);
}
catch (err) {
tag = '';
}
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.`);
} 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.');
}
}
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);
}
// 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 [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,
);
}
}
// 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,
);
}
}

View file

@ -5,20 +5,53 @@ 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 commitSet = new CommitInfoSet(false, [
new CommitInfo(
"",
"Second Commit SomeValue",
"",
"",
"",
new Date(),
"",
"",
new Date(),
[],
),
new CommitInfo(
"",
"Initial Commit",
"",
"",
"",
new Date(),
"",
"",
new Date(),
[],
),
]);
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(), []),
]);
const result = await classifier.ClassifyAsync(releaseInfo, commitSet);
const result = await classifier.ClassifyAsync(releaseInfo, commitSet);
expect(result.major).toBe(0);
expect(result.minor).toBe(1);
expect(result.patch).toBe(0);
expect(result.increment).toBe(0);
});
expect(result.major).toBe(0);
expect(result.minor).toBe(1);
expect(result.patch).toBe(0);
expect(result.increment).toBe(0);
});

View file

@ -7,111 +7,184 @@ 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;
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.enablePrereleaseMode = config.enablePrereleaseMode;
}
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.enablePrereleaseMode = config.enablePrereleaseMode;
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);
} else {
const matchString = pattern;
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 } {
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,
};
case VersionType.None:
return {
major: current.major,
minor: current.minor,
patch: current.patch,
};
default:
throw new Error(`Unknown change type: ${type}`);
}
}
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);
} else {
const matchString = pattern;
return searchBody ?
(commit: CommitInfo) => commit.subject.includes(matchString) || commit.body.includes(matchString) :
(commit: CommitInfo) => commit.subject.includes(matchString);
}
switch (type) {
case VersionType.Major:
return { major: current.major + 1, minor: 0, patch: 0 };
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,
};
case VersionType.None:
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;
} {
if (commitsSet.commits.length === 0) {
return {
type: VersionType.None,
increment: 0,
changed: commitsSet.changed,
};
}
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 };
case VersionType.None:
return { major: current.major, minor: current.minor, patch: current.patch };
default:
throw new Error(`Unknown change type: ${type}`);
}
}
switch (type) {
case VersionType.Major:
return { major: current.major + 1, minor: 0, patch: 0 };
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 };
case VersionType.None:
return { major: current.major, minor: current.minor, patch: current.patch };
default:
throw new Error(`Unknown change type: ${type}`);
}
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,
};
}
index++;
}
private resolveCommitType(commitsSet: CommitInfoSet): ({ type: VersionType, increment: number, changed: boolean }) {
if (commitsSet.commits.length === 0) {
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 };
}
index++;
}
index = 1;
for (let commit of commits) {
if (this.minorPattern(commit)) {
return { type: VersionType.Minor, increment: commits.length - index, changed: commitsSet.changed };
}
index++;
}
return { type: VersionType.Patch, increment: commitsSet.commits.length - 1, changed: true };
index = 1;
for (let commit of commits) {
if (this.minorPattern(commit)) {
return {
type: VersionType.Minor,
increment: commits.length - index,
changed: commitsSet.changed,
};
}
index++;
}
public async ClassifyAsync(lastRelease: ReleaseInformation, commitSet: CommitInfoSet): Promise<VersionClassification> {
return {
type: VersionType.Patch,
increment: commitsSet.commits.length - 1,
changed: true,
};
}
const { type, increment, changed } = this.resolveCommitType(commitSet);
public async ClassifyAsync(
lastRelease: ReleaseInformation,
commitSet: CommitInfoSet,
): Promise<VersionClassification> {
const { type, increment, changed } = this.resolveCommitType(commitSet);
const { major, minor, patch } = this.getNextVersion(lastRelease, type);
const { major, minor, patch } = this.getNextVersion(lastRelease, type);
if (lastRelease.currentPatch !== null) {
// If the current commit is tagged, we must use that version. Here we check if the version we have resolved from the
// previous commits is the same as the current version. If it is, we will use the increment value, otherwise we reset
// to zero. For example:
if (lastRelease.currentPatch !== null) {
// If the current commit is tagged, we must use that version. Here we check if the version we have resolved from the
// previous commits is the same as the current version. If it is, we will use the increment value, otherwise we reset
// to zero. For example:
// - commit 1 - v1.0.0+0
// - commit 2 - v1.0.0+1
// - commit 3 was tagged v2.0.0 - v2.0.0+0
// - commit 4 - v2.0.1+0
// - commit 1 - v1.0.0+0
// - 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 currentIncrement = versionsMatch ? increment : 0;
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);
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(
type,
increment,
changed,
major,
minor,
patch,
);
}
}

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>;
}

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,
) {}
}

View file

@ -1,8 +1,7 @@
/** Represents information about a user (e.g. committer, author, tagger) */
export class UserInfo {
/**
* Creates a new instance
* Creates a new instance
* @param name - User's name
* @param email - User's email
* @param commits - Number of commits in the scope evaluated
@ -10,5 +9,6 @@ export class UserInfo {
constructor(
public name: string,
public email: string,
public commits: number) { }
public commits: number,
) {}
}

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,
) {}
}

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>;
}

View file

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

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",
}