Skip to content

Export generateReleaseNotesFromPRs and parsePR #3802

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

Merged
M-i-k-e-l merged 1 commit into from
Sep 14, 2025
Merged

Export generateReleaseNotesFromPRs and parsePR #3802

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 15 additions & 4 deletions scripts/release/prReleaseNotesCommon.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ async function fetchMergedPRs(postMergedDate, _repo, isPatchRelease) {
info: parsePR(pr.body)
};
} catch {
// eslint-disable-next-line no-restricted-syntax
console.error('Failed parsing PR: ', pr.url);
return null;
}
Expand Down Expand Up @@ -164,9 +165,7 @@ function getReleaseNotesForType(PRs, title) {
return releaseNotes;
}

async function _generateReleaseNotes(latestVersion, newVersion, fileNamePrefix, repo, header, tagPrefix, categories, isPatchRelease) {
const latestReleaseDate = fetchLatestReleaseDate(tagPrefix, latestVersion);
const PRs = await fetchMergedPRs(latestReleaseDate, repo, isPatchRelease);
function generateReleaseNotesFromPRs(PRs, categories, header) {
if (!PRs) {
return;
}
Expand Down Expand Up @@ -198,10 +197,20 @@ async function _generateReleaseNotes(latestVersion, newVersion, fileNamePrefix,

releaseNotes += getTitle(':bulb: Deprecations & Migrations');

return releaseNotes;
}

// eslint-disable-next-line max-len, max-params
async function _generateReleaseNotes(latestVersion, newVersion, fileNamePrefix, repo, header, tagPrefix, categories, isPatchRelease) {
const latestReleaseDate = fetchLatestReleaseDate(tagPrefix, latestVersion);
const PRs = await fetchMergedPRs(latestReleaseDate, repo, isPatchRelease);
const releaseNotes = generateReleaseNotesFromPRs(PRs, categories, header);

fs.writeFileSync(`${process.env.HOME}/Downloads/${fileNamePrefix}-release-notes_${newVersion}.txt`, releaseNotes, {
encoding: 'utf8'
});

// eslint-disable-next-line max-len
console.log(`\x1b[1m\x1b[32m✔\x1b[0m \x1b[32m${fileNamePrefix}-release-notes.txt was successfully written to ${process.env.HOME}/Downloads\x1b[0m \x1b[1m\x1b[32m✔\x1b[0m`);
}

Expand All @@ -212,6 +221,7 @@ function isPatchRelease(lastVersion, newVersion) {
return lastMajor === newMajor && lastMinor === newMinor && newPatch - lastPatch > 0;
}

// eslint-disable-next-line max-params
async function generateReleaseNotes(latestVersion,
newVersion,
fileNamePrefix,
Expand All @@ -238,8 +248,9 @@ async function generateReleaseNotes(latestVersion,
const header = getHeader(newVer);
console.info(`Current latest version is v${latestVer}`);
console.info(`Generating release notes out or PRs for v${newVer}`);
// eslint-disable-next-line max-len
_generateReleaseNotes(latestVer, newVer, fileNamePrefix, repo, header, tagPrefix, categories, isPatchRelease(latestVer, newVer));
});
}

module.exports = {generateReleaseNotes};
module.exports = {generateReleaseNotes, generateReleaseNotesFromPRs, parsePR};