#!/usr/bin/env node /** * Copyright (c) OpenLens Authors. All rights reserved. * Licensed under MIT License. See LICENSE in root directory for more information. */ import assert from "assert"; import child_process from "child_process"; import { readFile } from "fs/promises"; import inquirer from "inquirer"; import { createInterface, ReadLine } from "readline"; import semver from "semver"; import { promisify } from "util"; type SemVer = semver.SemVer; const { SemVer, valid: semverValid, rcompare: semverRcompare, lte: semverLte, } = semver; const exec = promisify(child_process.exec); const spawn = promisify(child_process.spawn); interface GithubPrData { author: { login: string; }; labels: { id: string; name: string; description: string; color: string; }[]; mergeCommit: { oid: string; }; mergedAt: string; milestone: { number: number; title: string; description: string; dueOn: null | string; }; number: number; title: string; } interface ExtendedGithubPrData extends Omit { mergedAt: Date; } async function getCurrentBranch(): Promise { return (await exec("git branch --show-current")).stdout.trim(); } async function getAbsolutePathToRepoRoot(): Promise { return (await exec("git rev-parse --show-toplevel")).stdout.trim(); } async function fetchAllGitTags(): Promise { await spawn("git", ["fetch", "--tags", "--force"], { stdio: "inherit", }); return (await exec("git tag --list", { encoding: "utf-8" })) .stdout .split(/\r?\n/) .map(line => line.trim()); } async function bumpPackageVersions(): Promise { await spawn("npm", ["run", "bump-version"], { stdio: "inherit", }); } function findClosestVersionTagLessThanVersion(tags: string[], version: SemVer): string { const lessThanTags = tags .map((value) => semverValid(value)) .filter((v): v is string => typeof v === "string") .sort(semverRcompare) .filter(version => semverLte(version, version)); assert(lessThanTags.length > 0, `Cannot find version tag less than ${version.format()}`); return lessThanTags[0]; } async function getCurrentVersionOfSubPackage(packageName: string): Promise { const packageJson = JSON.parse(await readFile(`./packages/${packageName}/package.json`, "utf-8")); return new SemVer(packageJson.version); } async function checkCurrentWorkingDirectory(): Promise { const repoRoot = await getAbsolutePathToRepoRoot(); if (process.cwd() !== repoRoot) { console.error("It looks like you are running this script from the 'scripts' directory. This script assumes it is run from the root of the git repo"); process.exit(1); } } function formatSemverForMilestone(version: SemVer): string { return `${version.major}.${version.minor}.${version.patch}`; } async function createReleaseBranchAndCommit(prBase: string, version: SemVer, prBody: string): Promise { const prBranch = `release/v${version.format()}`; await spawn("git", ["checkout", "-b", prBranch], { stdio: "inherit", }); await spawn("git", ["add", "lerna.json", "packages/*/package.json"], { stdio: "inherit", }); await spawn("git", ["commit", "-sm", `"Release ${version.format()}"`], { stdio: "inherit", }); await spawn("git", ["push", "--set-upstream", "origin", prBranch], { stdio: "inherit", }); await spawn("gh", [ "pr", "create", "--base", prBase, "--title", `Release ${version.format()}`, "--label", "skip-changelog", "--label", "release", "--milestone", formatSemverForMilestone(version), "--body-file", prBody, ], { stdio: "inherit" }); } function sortExtendedGithubPrData(left: ExtendedGithubPrData, right: ExtendedGithubPrData): number { const leftAge = left.mergedAt.valueOf(); const rightAge = right.mergedAt.valueOf(); if (leftAge === rightAge) { return 0; } if (leftAge > rightAge) { return 1; } return -1; } async function getRelaventPRs(milestone: string, previousReleasedVersion: string): Promise { console.log("retreiving previous 500 PRs..."); const getMergedPrsArgs = [ "gh", "pr", "list", "--limit=500", // Should be big enough, if not we need to release more often ;) "--state=merged", "--base=master", "--json mergeCommit,title,author,labels,number,milestone,mergedAt", ]; const mergedPrs = JSON.parse((await exec(getMergedPrsArgs.join(" "), { encoding: "utf-8" })).stdout) as GithubPrData[]; const milestoneRelevantPrs = mergedPrs.filter(pr => pr.milestone?.title === milestone); const relaventPrsQuery = await Promise.all( milestoneRelevantPrs.map(async pr => ({ pr, stdout: (await exec(`git tag v${previousReleasedVersion} --no-contains ${pr.mergeCommit.oid}`)).stdout, })), ); return relaventPrsQuery .filter(query => query.stdout) .map(query => query.pr) .filter(pr => pr.labels.every(label => label.name !== "skip-changelog")) .map(pr => ({ ...pr, mergedAt: new Date(pr.mergedAt) } as ExtendedGithubPrData)) .sort(sortExtendedGithubPrData); } function formatPrEntry(pr: ExtendedGithubPrData) { return `- ${pr.title} (**[#${pr.number}](https://github.com/lensapp/lens/pull/${pr.number})**) https://github.com/${pr.author.login}`; } const isEnhancementPr = (pr: ExtendedGithubPrData) => pr.labels.some(label => label.name === "enhancement"); const isBugfixPr = (pr: ExtendedGithubPrData) => pr.labels.some(label => label.name === "bug"); const cherrypickCommitWith = (rl: ReadLine) => async (commit: string) => { try { await spawn("git", ["cherry-pick", commit], { stdio: "inherit", }); } catch { console.error(`Please resolve conflicts and then press enter here...`); await new Promise(resolve => rl.once("line", () => resolve())); } }; async function pickWhichCommitsToUse(prs: ExtendedGithubPrData[]): Promise { console.log("Pick which commits to use..."); const answers = await inquirer.prompt>>(prs.map(pr => ({ message: `#${pr.number}: ${pr.title}`, type: "checkbox", default: true, name: pr.number, }))); return prs.filter(pr => answers[pr.number]); } function formatChangelog(previousReleasedVersion: string, prs: ExtendedGithubPrData[]): string { const enhancementPrLines: string[] = []; const bugPrLines: string[] = []; const maintenencePrLines: string[] = []; for (const pr of prs) { if (isEnhancementPr(pr)) { enhancementPrLines.push(formatPrEntry(pr)); } else if (isBugfixPr(pr)) { bugPrLines.push(formatPrEntry(pr)); } else { maintenencePrLines.push(formatPrEntry(pr)); } } if (enhancementPrLines.length > 0) { enhancementPrLines.unshift("## 🚀 Features", ""); enhancementPrLines.push(""); } if (bugPrLines.length > 0) { bugPrLines.unshift("## 🐛 Bug Fixes", ""); bugPrLines.push(""); } if (maintenencePrLines.length > 0) { maintenencePrLines.unshift("## 🧰 Maintenance", ""); maintenencePrLines.push(""); } return [ `## Changes since ${previousReleasedVersion}`, "", ...enhancementPrLines, ...bugPrLines, ...maintenencePrLines, ].join("\n"); } async function cherrypickCommits(prs: ExtendedGithubPrData[]): Promise { const rl = createInterface(process.stdin); const cherrypickCommit = cherrypickCommitWith(rl); for (const pr of prs) { await cherrypickCommit(pr.mergeCommit.oid); } rl.close(); } async function pickRelaventPrs(prs: ExtendedGithubPrData[], isMasterBranch: boolean): Promise { if (isMasterBranch) { return prs; } const selectedPrs = await pickWhichCommitsToUse(prs); await cherrypickCommits(selectedPrs); return selectedPrs; } async function createRelease(): Promise { await checkCurrentWorkingDirectory(); const currentK8slensCoreVersion = await getCurrentVersionOfSubPackage("core"); const prBase = await getCurrentBranch(); const isMasterBranch = prBase === "master"; const tags = await fetchAllGitTags(); const previousReleasedVersion = findClosestVersionTagLessThanVersion(tags, currentK8slensCoreVersion); if (isMasterBranch) { await bumpPackageVersions(); } const prMilestone = formatSemverForMilestone(await getCurrentVersionOfSubPackage("core")); const relaventPrs = await getRelaventPRs(prMilestone, previousReleasedVersion); const selectedPrs = await pickRelaventPrs(relaventPrs, isMasterBranch); const prBody = formatChangelog(previousReleasedVersion, selectedPrs); if (!isMasterBranch) { await bumpPackageVersions(); } const newK8slensCoreVersion = await getCurrentVersionOfSubPackage("core"); await createReleaseBranchAndCommit(prBase, newK8slensCoreVersion, prBody); } await createRelease();