Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

build(deps): bump @metamask/auto-changelog from 3.3.0 to 3.4.0 #122

Closed
wants to merge 2 commits into from
Closed

build(deps): bump @metamask/auto-changelog from 3.3.0 to 3.4.0 #122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
55d3c65
build(deps): bump @metamask/auto-changelog from 3.3.0 to 3.4.0
dependabot[bot] Oct 22, 2023
817ce63
build dist
legobeat Oct 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
196 changes: 133 additions & 63 deletions dist/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2162,8 +2162,9 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
var _Changelog_releases, _Changelog_changes, _Changelog_repoUrl, _Changelog_tagPrefix, _Changelog_formatter;
var _Changelog_releases, _Changelog_changes, _Changelog_repoUrl, _Changelog_tagPrefix, _Changelog_formatter, _Changelog_packageRename;
Object.defineProperty(exports, "__esModule", ({ value: true }));
const utils_1 = __nccwpck_require__(2512);
const semver_1 = __importDefault(__nccwpck_require__(1383));
const constants_1 = __nccwpck_require__(1373);
const changelogTitle = '# Changelog';
Expand Down Expand Up @@ -2204,7 +2205,8 @@ function stringifyRelease(version, categories, { date, status } = {}) {
const categorizedChanges = constants_1.orderedChangeCategories
.filter((category) => categories[category])
.map((category) => {
const changes = categories[category];
var _a;
const changes = (_a = categories[category]) !== null && _a !== void 0 ? _a : [];
return stringifyCategory(category, changes);
})
.join('\n\n');
Expand Down Expand Up @@ -2267,19 +2269,25 @@ function getTagUrl(repoUrl, tag) {
* @param repoUrl - The URL for the GitHub repository.
* @param tagPrefix - The prefix used in tags before the version number.
* @param releases - The releases to generate link definitions for.
* @param packageRename - The package rename properties
* An optional, which is required only in case of package renamed.
* @returns The stringified release link definitions.
*/
function stringifyLinkReferenceDefinitions(repoUrl, tagPrefix, releases) {
// A list of release versions in descending SemVer order
const descendingSemverVersions = releases
.map(({ version }) => version)
.sort((a, b) => {
return semver_1.default.gt(a, b) ? -1 : 1;
});
const latestSemverVersion = descendingSemverVersions[0];
// A list of release versions in chronological order
const chronologicalVersions = releases.map(({ version }) => version);
const hasReleases = chronologicalVersions.length > 0;
function stringifyLinkReferenceDefinitions(repoUrl, tagPrefix, releases, packageRename) {
const unreleasedLinkReferenceDefinition = getUnreleasedLinkReferenceDefinition(repoUrl, tagPrefix, releases, packageRename);
const releaseLinkReferenceDefinitions = getReleaseLinkReferenceDefinitions(repoUrl, tagPrefix, releases, packageRename).join('\n');
return `${unreleasedLinkReferenceDefinition}\n${releaseLinkReferenceDefinitions}${releases.length > 0 ? '\n' : ''}`;
}
/**
* Get a string of unreleased link reference definition.
*
* @param repoUrl - The URL for the GitHub repository.
* @param tagPrefix - The prefix used in tags before the version number.
* @param releases - The releases to generate link definitions for.
* @param packageRename - The package rename properties.
* @returns A unreleased link reference definition string.
*/
function getUnreleasedLinkReferenceDefinition(repoUrl, tagPrefix, releases, packageRename) {
// The "Unreleased" section represents all changes made since the *highest*
// release, not the most recent release. This is to accomodate patch releases
// of older versions that don't represent the latest set of changes.
Expand All @@ -2290,18 +2298,47 @@ function stringifyLinkReferenceDefinitions(repoUrl, tagPrefix, releases) {
//
// If there have not been any releases yet, the repo URL is used directly as
// the link definition.
const unreleasedLinkReferenceDefinition = `[${constants_1.unreleased}]: ${hasReleases
? getCompareUrl(repoUrl, `${tagPrefix}${latestSemverVersion}`, 'HEAD')
// A list of release versions in descending SemVer order
const descendingSemverVersions = releases
.map(({ version }) => version)
.sort((a, b) => {
return semver_1.default.gt(a, b) ? -1 : 1;
});
const latestSemverVersion = descendingSemverVersions[0];
const hasReleases = descendingSemverVersions.length > 0;
// if there is a package renamed, the tag prefix before the rename will be considered for compare
// [Unreleased]: https://github.com/ExampleUsernameOrOrganization/ExampleRepository/compare/test@0.0.2...HEAD
const tagPrefixToCompare = packageRename && packageRename.versionBeforeRename === latestSemverVersion
? packageRename.tagPrefixBeforeRename
: tagPrefix;
return `[${constants_1.unreleased}]: ${hasReleases
? getCompareUrl(repoUrl, `${tagPrefixToCompare}${latestSemverVersion}`, 'HEAD')
: withTrailingSlash(repoUrl)}`;
}
/**
* Get a list of release link reference definitions.
*
* @param repoUrl - The URL for the GitHub repository.
* @param tagPrefix - The prefix used in tags before the version number.
* @param releases - The releases to generate link definitions for.
* @param packageRename - The package rename properties.
* @returns A list of release link reference definitions.
*/
function getReleaseLinkReferenceDefinitions(repoUrl, tagPrefix, releases, packageRename) {
// The "previous" release that should be used for comparison is not always
// the most recent release chronologically. The _highest_ version that is
// lower than the current release is used as the previous release, so that
// patch releases on older releases can be accomodated.
const releaseLinkReferenceDefinitions = releases
.map(({ version }) => {
const chronologicalVersions = releases.map(({ version }) => version);
let tagPrefixToCompare = tagPrefix;
const releaseLinkReferenceDefinitions = releases.map(({ version }) => {
let diffUrl;
// once the version matches with versionBeforeRename, rest of the lines in changelog will be assumed as migrated tags
if (packageRename && packageRename.versionBeforeRename === version) {
tagPrefixToCompare = packageRename.tagPrefixBeforeRename;
}
if (version === chronologicalVersions[chronologicalVersions.length - 1]) {
diffUrl = getTagUrl(repoUrl, `${tagPrefix}${version}`);
diffUrl = getTagUrl(repoUrl, `${tagPrefixToCompare}${version}`);
}
else {
const versionIndex = chronologicalVersions.indexOf(version);
Expand All @@ -2310,14 +2347,28 @@ function stringifyLinkReferenceDefinitions(repoUrl, tagPrefix, releases) {
.find((releaseVersion) => {
return semver_1.default.gt(version, releaseVersion);
});
diffUrl = previousVersion
? getCompareUrl(repoUrl, `${tagPrefix}${previousVersion}`, `${tagPrefix}${version}`)
: getTagUrl(repoUrl, `${tagPrefix}${version}`);
if (previousVersion) {
if (packageRename &&
packageRename.versionBeforeRename === previousVersion) {
// The package was renamed at this version
// (the tag prefix holds the new name).
diffUrl = getCompareUrl(repoUrl, `${packageRename.tagPrefixBeforeRename}${previousVersion}`, `${tagPrefix}${version}`);
}
else {
// If the package was ever renamed, it was not renamed at this version,
// so use either the old tag prefix or the new tag prefix.
// If the package was never renamed, use the tag prefix as it is.
diffUrl = getCompareUrl(repoUrl, `${tagPrefixToCompare}${previousVersion}`, `${tagPrefixToCompare}${version}`);
}
}
else {
// This is the smallest release.
diffUrl = getTagUrl(repoUrl, `${tagPrefixToCompare}${version}`);
}
}
return `[${version}]: ${diffUrl}`;
})
.join('\n');
return `${unreleasedLinkReferenceDefinition}\n${releaseLinkReferenceDefinitions}${releases.length > 0 ? '\n' : ''}`;
});
return releaseLinkReferenceDefinitions;
}
/**
* A changelog that complies with the
Expand All @@ -2336,18 +2387,22 @@ class Changelog {
* @param options.repoUrl - The GitHub repository URL for the current project.
* @param options.tagPrefix - The prefix used in tags before the version number.
* @param options.formatter - A function that formats the changelog string.
* @param options.packageRename - The package rename properties.
* An optional, which is required only in case of package renamed.
*/
constructor({ repoUrl, tagPrefix = 'v', formatter = (changelog) => changelog, }) {
constructor({ repoUrl, tagPrefix = 'v', formatter = (changelog) => changelog, packageRename, }) {
_Changelog_releases.set(this, void 0);
_Changelog_changes.set(this, void 0);
_Changelog_repoUrl.set(this, void 0);
_Changelog_tagPrefix.set(this, void 0);
_Changelog_formatter.set(this, void 0);
_Changelog_packageRename.set(this, void 0);
__classPrivateFieldSet(this, _Changelog_releases, [], "f");
__classPrivateFieldSet(this, _Changelog_changes, { [constants_1.unreleased]: {} }, "f");
__classPrivateFieldSet(this, _Changelog_repoUrl, repoUrl, "f");
__classPrivateFieldSet(this, _Changelog_tagPrefix, tagPrefix, "f");
__classPrivateFieldSet(this, _Changelog_formatter, formatter, "f");
__classPrivateFieldSet(this, _Changelog_packageRename, packageRename, "f");
}
/**
* Add a release to the changelog.
Expand Down Expand Up @@ -2433,16 +2488,17 @@ class Changelog {
* @param version - The release version to migrate unreleased changes to.
*/
migrateUnreleasedChangesToRelease(version) {
var _a, _b;
const releaseChanges = __classPrivateFieldGet(this, _Changelog_changes, "f")[version];
if (!releaseChanges) {
throw new Error(`Specified release version does not exist: '${version}'`);
}
const unreleasedChanges = __classPrivateFieldGet(this, _Changelog_changes, "f")[constants_1.unreleased];
for (const category of Object.keys(unreleasedChanges)) {
for (const category of (0, utils_1.getKnownPropertyNames)(unreleasedChanges)) {
if (releaseChanges[category]) {
releaseChanges[category] = [
...unreleasedChanges[category],
...releaseChanges[category],
...((_a = unreleasedChanges[category]) !== null && _a !== void 0 ? _a : []),
...((_b = releaseChanges[category]) !== null && _b !== void 0 ? _b : []),
];
}
else {
Expand Down Expand Up @@ -2511,12 +2567,12 @@ ${changelogDescription}

${stringifyReleases(__classPrivateFieldGet(this, _Changelog_releases, "f"), __classPrivateFieldGet(this, _Changelog_changes, "f"))}

${stringifyLinkReferenceDefinitions(__classPrivateFieldGet(this, _Changelog_repoUrl, "f"), __classPrivateFieldGet(this, _Changelog_tagPrefix, "f"), __classPrivateFieldGet(this, _Changelog_releases, "f"))}`;
${stringifyLinkReferenceDefinitions(__classPrivateFieldGet(this, _Changelog_repoUrl, "f"), __classPrivateFieldGet(this, _Changelog_tagPrefix, "f"), __classPrivateFieldGet(this, _Changelog_releases, "f"), __classPrivateFieldGet(this, _Changelog_packageRename, "f"))}`;
return __classPrivateFieldGet(this, _Changelog_formatter, "f").call(this, changelog);
}
}
exports["default"] = Changelog;
_Changelog_releases = new WeakMap(), _Changelog_changes = new WeakMap(), _Changelog_repoUrl = new WeakMap(), _Changelog_tagPrefix = new WeakMap(), _Changelog_formatter = new WeakMap();
_Changelog_releases = new WeakMap(), _Changelog_changes = new WeakMap(), _Changelog_repoUrl = new WeakMap(), _Changelog_tagPrefix = new WeakMap(), _Changelog_formatter = new WeakMap(), _Changelog_packageRename = new WeakMap();
//# sourceMappingURL=changelog.js.map

/***/ }),
Expand Down Expand Up @@ -2680,11 +2736,18 @@ function isValidChangeCategory(category) {
* @param options.repoUrl - The GitHub repository URL for the current project.
* @param options.tagPrefix - The prefix used in tags before the version number.
* @param options.formatter - A custom Markdown formatter to use.
* @param options.packageRename - The package rename properties
* An optional, which is required only in case of package renamed.
* @returns A changelog instance that reflects the changelog text provided.
*/
function parseChangelog({ changelogContent, repoUrl, tagPrefix = 'v', formatter = undefined, }) {
function parseChangelog({ changelogContent, repoUrl, tagPrefix = 'v', formatter = undefined, packageRename, }) {
const changelogLines = changelogContent.split('\n');
const changelog = new changelog_1.default({ repoUrl, tagPrefix, formatter });
const changelog = new changelog_1.default({
repoUrl,
tagPrefix,
formatter,
packageRename,
});
const unreleasedHeaderIndex = changelogLines.indexOf(`## [${constants_1.unreleased}]`);
if (unreleasedHeaderIndex === -1) {
throw new Error(`Failed to find ${constants_1.unreleased} header`);
Expand Down Expand Up @@ -2960,9 +3023,6 @@ async function getCommitHashesInRange(commitRange, rootDirectory) {
* @returns The updated changelog text.
*/
async function updateChangelog({ changelogContent, currentVersion, repoUrl, isReleaseCandidate, projectRootDirectory, tagPrefixes = ['v'], formatter = undefined, }) {
if (isReleaseCandidate && !currentVersion) {
throw new Error(`A version must be specified if 'isReleaseCandidate' is set.`);
}
const changelog = (0, parse_changelog_1.parseChangelog)({
changelogContent,
repoUrl,
Expand All @@ -2974,10 +3034,6 @@ async function updateChangelog({ changelogContent, currentVersion, repoUrl, isRe
const mostRecentTag = await getMostRecentTag({
tagPrefixes,
});
if (isReleaseCandidate &&
mostRecentTag === `${tagPrefixes[0]}${currentVersion || ''}`) {
throw new Error(`Current version already has tag, which is unexpected for a release candidate.`);
}
const commitRange = mostRecentTag === null ? 'HEAD' : `${mostRecentTag}..HEAD`;
const commitsHashesSinceLastRelease = await getCommitHashesInRange(commitRange, projectRootDirectory);
const commits = await getCommits(commitsHashesSinceLastRelease);
Expand All @@ -2988,33 +3044,36 @@ async function updateChangelog({ changelogContent, currentVersion, repoUrl, isRe
(!isReleaseCandidate || hasUnreleasedChanges)) {
return undefined;
}
// Ensure release header exists, if necessary
if (isReleaseCandidate &&
!changelog
if (isReleaseCandidate) {
if (!currentVersion) {
throw new Error(`A version must be specified if 'isReleaseCandidate' is set.`);
}
if (mostRecentTag === `${tagPrefixes[0]}${currentVersion !== null && currentVersion !== void 0 ? currentVersion : ''}`) {
throw new Error(`Current version already has a tag ('${mostRecentTag}'), which is unexpected for a release candidate.`);
}
// Ensure release header exists, if necessary
if (!changelog
.getReleases()
.find((release) => release.version === currentVersion)) {
// Typecast: currentVersion will be defined here due to type guard at the
// top of this function.
changelog.addRelease({ version: currentVersion });
}
if (isReleaseCandidate && hasUnreleasedChanges) {
// Typecast: currentVersion will be defined here due to type guard at the
// top of this function.
changelog.migrateUnreleasedChangesToRelease(currentVersion);
}
const newChangeEntries = newCommits.map(({ prNumber, description }) => {
if (prNumber) {
const suffix = `([#${prNumber}](${repoUrl}/pull/${prNumber}))`;
return `${description} ${suffix}`;
changelog.addRelease({ version: currentVersion });
}
return description;
});
for (const description of newChangeEntries.reverse()) {
changelog.addChange({
version: isReleaseCandidate ? currentVersion : undefined,
category: constants_1.ChangeCategory.Uncategorized,
description,
if (hasUnreleasedChanges) {
changelog.migrateUnreleasedChangesToRelease(currentVersion);
}
const newChangeEntries = newCommits.map(({ prNumber, description }) => {
if (prNumber) {
const suffix = `([#${prNumber}](${repoUrl}/pull/${prNumber}))`;
return `${description} ${suffix}`;
}
return description;
});
for (const description of newChangeEntries.reverse()) {
changelog.addChange({
version: isReleaseCandidate ? currentVersion : undefined,
category: constants_1.ChangeCategory.Uncategorized,
description,
});
}
}
return changelog.toString();
}
Expand Down Expand Up @@ -3118,6 +3177,8 @@ exports.ChangelogFormattingError = ChangelogFormattingError;
* header, and that there are no unreleased changes present.
* @param options.tagPrefix - The prefix used in tags before the version number.
* @param options.formatter - A custom Markdown formatter to use.
* @param options.packageRename - The package rename properties.
* An optional, which is required only in case of package renamed.
* @throws `InvalidChangelogError` - Will throw if the changelog is invalid
* @throws `MissingCurrentVersionError` - Will throw if `isReleaseCandidate` is
* `true` and the changelog is missing the release header for the current
Expand All @@ -3128,13 +3189,14 @@ exports.ChangelogFormattingError = ChangelogFormattingError;
* `true` and the changelog contains uncategorized changes.
* @throws `ChangelogFormattingError` - Will throw if there is a formatting error.
*/
function validateChangelog({ changelogContent, currentVersion, repoUrl, isReleaseCandidate, tagPrefix = 'v', formatter = undefined, }) {
function validateChangelog({ changelogContent, currentVersion, repoUrl, isReleaseCandidate, tagPrefix = 'v', formatter = undefined, packageRename, }) {
var _a, _b;
const changelog = (0, parse_changelog_1.parseChangelog)({
changelogContent,
repoUrl,
tagPrefix,
formatter,
packageRename,
});
const hasUnreleasedChanges = Object.keys(changelog.getUnreleasedChanges()).length !== 0;
const releaseChanges = currentVersion
Expand Down Expand Up @@ -64036,6 +64098,14 @@ try {
} catch (er) {}


/***/ }),

/***/ 2512:
/***/ ((module) => {

module.exports = eval("require")("@metamask/utils");


/***/ }),

/***/ 9491:
Expand Down
6 changes: 3 additions & 3 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -668,9 +668,9 @@
semver "^7.3.5"

"@metamask/auto-changelog@^3.3.0":
version "3.3.0"
resolved "https://registry.yarnpkg.com/@metamask/auto-changelog/-/auto-changelog-3.3.0.tgz#9b9c2c4e4f5d65d85abcb3d9f6eedc32ea4518fd"
integrity sha512-Azv5WhR8N6iFUqcVfogM+aqkj/vWNv7CXD9TeSdlE1eoKV/TVtDe/dhRz+SjFJ8KK3u1dBuIrYypb2qBTh8Q8A==
version "3.4.0"
resolved "https://registry.yarnpkg.com/@metamask/auto-changelog/-/auto-changelog-3.4.0.tgz#c21da1076745e692043b26b61f1e72ef59e50ab9"
integrity sha512-H7aF40DGLtUynyFzESskltpGZIaA1v+Lhv9HoeJsG2ooGN78IaiguF/i8Uxg5sJvIuvSzugWvQ+ZF4I/5Rh/hw==
dependencies:
diff "^5.0.0"
execa "^5.1.1"
Expand Down
Loading