mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-16 19:43:29 +01:00
ci: better release workflow (#10325)
* ci: better release workflow * ci: simplify + use changelog * ci(release): better parsing and exclusions * ci(release): remove tree log * ci(release): improve logs * ci(release): properly check inputs * ci(release): better promise handling Co-authored-by: Aura <kyradiscord@gmail.com> * ci: refactor release to use bun * ci(release): whitespace Co-authored-by: Vlad Frangu <kingdgrizzle@gmail.com> * ci(release): add dev release handling * ci(release): fixes from testing * ci(release): make the promise run * ci(release): when specifying package, skip exclusions * ci(dev): create-discord-bot dev release * ci(release): improve changelog detection * ci: fix typo and allow releasing branches * ci(release): set make_latest for gh releases * ci(release): add ssh_key so pushed tags run workflow --------- Co-authored-by: Aura <kyradiscord@gmail.com> Co-authored-by: Vlad Frangu <kingdgrizzle@gmail.com> Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
This commit is contained in:
ckohen
230
packages/actions/src/releasePackages/generateReleaseTree.ts
Normal file
230
packages/actions/src/releasePackages/generateReleaseTree.ts
Normal file
@@ -0,0 +1,230 @@
|
||||
import { info, warning } from '@actions/core';
|
||||
import type { PackageJSON, PackumentVersion } from '@npm/types';
|
||||
import { $, file, write } from 'bun';
|
||||
|
||||
const nonNodePackages = new Set(['@discordjs/proxy-container']);
|
||||
|
||||
interface pnpmTreeDependency {
|
||||
from: string;
|
||||
path: string;
|
||||
version: string;
|
||||
}
|
||||
|
||||
interface pnpmTree {
|
||||
dependencies?: Record<string, pnpmTreeDependency>;
|
||||
name?: string;
|
||||
path: string;
|
||||
private?: boolean;
|
||||
unsavedDependencies?: Record<string, pnpmTreeDependency>;
|
||||
version?: string;
|
||||
}
|
||||
|
||||
export interface ReleaseEntry {
|
||||
changelog?: string;
|
||||
dependsOn?: string[];
|
||||
name: string;
|
||||
version: string;
|
||||
}
|
||||
|
||||
async function fetchDevVersion(pkg: string) {
|
||||
try {
|
||||
const res = await fetch(`https://registry.npmjs.org/${pkg}/dev`);
|
||||
if (!res.ok) return null;
|
||||
const packument = (await res.json()) as PackumentVersion;
|
||||
return packument.version;
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
async function getReleaseEntries(dev: boolean, dry: boolean) {
|
||||
const releaseEntries: ReleaseEntry[] = [];
|
||||
const packageList: pnpmTree[] =
|
||||
await $`pnpm list --recursive --only-projects --filter {packages/\*} --prod --json`.json();
|
||||
|
||||
const commitHash = (await $`git rev-parse --short HEAD`.text()).trim();
|
||||
|
||||
for (const pkg of packageList) {
|
||||
// Don't release private packages ever (npm will error anyways)
|
||||
if (pkg.private) continue;
|
||||
// Just in case
|
||||
if (!pkg.version || !pkg.name) continue;
|
||||
if (nonNodePackages.has(pkg.name)) continue;
|
||||
|
||||
const release: ReleaseEntry = {
|
||||
name: pkg.name,
|
||||
version: pkg.version,
|
||||
};
|
||||
|
||||
if (dev) {
|
||||
const devVersion = await fetchDevVersion(pkg.name);
|
||||
if (devVersion?.endsWith(commitHash)) {
|
||||
// Write the currently released dev version so when pnpm publish runs on dependents they depend on the dev versions
|
||||
if (dry) {
|
||||
info(`[DRY] ${pkg.name}@${devVersion} already released. Editing package.json version.`);
|
||||
} else {
|
||||
const pkgJson = (await file(`${pkg.path}/package.json`).json()) as PackageJSON;
|
||||
pkgJson.version = devVersion;
|
||||
await write(`${pkg.path}/package.json`, JSON.stringify(pkgJson, null, '\t'));
|
||||
}
|
||||
|
||||
release.version = devVersion;
|
||||
} else if (dry) {
|
||||
info(`[DRY] Bumping ${pkg.name} via git-cliff.`);
|
||||
release.version = `${pkg.version}.DRY-dev.${Math.round(Date.now() / 1_000)}-${commitHash}`;
|
||||
} else {
|
||||
await $`pnpm --filter=${pkg.name} run release --preid "dev.${Math.round(Date.now() / 1_000)}-${commitHash} --skip-changelog"`;
|
||||
// Read again instead of parsing the output to be sure we're matching when checking against npm
|
||||
const pkgJson = (await file(`${pkg.path}/package.json`).json()) as PackageJSON;
|
||||
release.version = pkgJson.version;
|
||||
}
|
||||
}
|
||||
// Only need changelog for releases published to github
|
||||
else {
|
||||
try {
|
||||
// Find and parse changelog to post in github release
|
||||
const changelogFile = await file(`${pkg.path}/CHANGELOG.md`).text();
|
||||
|
||||
let changelogLines: string[] = [];
|
||||
let foundChangelog = false;
|
||||
|
||||
for (const line of changelogFile.split('\n')) {
|
||||
if (line.startsWith('# [')) {
|
||||
if (foundChangelog) {
|
||||
if (changelogLines.at(-1) === '') {
|
||||
changelogLines = changelogLines.slice(2, -1);
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
|
||||
// Check changelog release version and assume no changelog if version does not match
|
||||
if (!line.startsWith(`# [${release.name === 'discord.js' ? `` : `${release.name}@`}${release.version}]`)) {
|
||||
break;
|
||||
}
|
||||
|
||||
foundChangelog = true;
|
||||
}
|
||||
|
||||
if (foundChangelog) {
|
||||
changelogLines.push(line);
|
||||
}
|
||||
}
|
||||
|
||||
release.changelog = changelogLines.join('\n');
|
||||
} catch (error) {
|
||||
// Probably just no changelog file but log just in case
|
||||
warning(`Error parsing changelog for ${pkg.name}, will use auto generated: ${error}`);
|
||||
}
|
||||
}
|
||||
|
||||
if (pkg.dependencies) {
|
||||
release.dependsOn = Object.keys(pkg.dependencies);
|
||||
}
|
||||
|
||||
releaseEntries.push(release);
|
||||
}
|
||||
|
||||
return releaseEntries;
|
||||
}
|
||||
|
||||
export async function generateReleaseTree(dev: boolean, dry: boolean, packageName?: string, exclude?: string[]) {
|
||||
let releaseEntries = await getReleaseEntries(dev, dry);
|
||||
// Try to early return if the package doesn't have deps
|
||||
if (packageName && packageName !== 'all') {
|
||||
const releaseEntry = releaseEntries.find((entry) => entry.name === packageName);
|
||||
if (!releaseEntry) {
|
||||
throw new Error(`Package ${packageName} not releaseable`);
|
||||
}
|
||||
|
||||
if (!releaseEntry.dependsOn) {
|
||||
return [[releaseEntry]];
|
||||
}
|
||||
}
|
||||
|
||||
// Generate the whole tree first, then prune if specified
|
||||
const releaseTree: ReleaseEntry[][] = [];
|
||||
const didRelease = new Set<string>();
|
||||
|
||||
while (releaseEntries.length) {
|
||||
const nextBranch: ReleaseEntry[] = [];
|
||||
const unreleased: ReleaseEntry[] = [];
|
||||
for (const entry of releaseEntries) {
|
||||
if (!entry.dependsOn) {
|
||||
nextBranch.push(entry);
|
||||
continue;
|
||||
}
|
||||
|
||||
const allDepsReleased = entry.dependsOn.every((dep) => didRelease.has(dep));
|
||||
if (allDepsReleased) {
|
||||
nextBranch.push(entry);
|
||||
} else {
|
||||
unreleased.push(entry);
|
||||
}
|
||||
}
|
||||
|
||||
// Update didRelease in a second loop to avoid loop order issues
|
||||
for (const release of nextBranch) {
|
||||
didRelease.add(release.name);
|
||||
}
|
||||
|
||||
if (releaseEntries.length === unreleased.length) {
|
||||
throw new Error(
|
||||
`One or more packages have dependents that can't be released: ${unreleased.map((entry) => entry.name).join(',')}`,
|
||||
);
|
||||
}
|
||||
|
||||
releaseTree.push(nextBranch);
|
||||
releaseEntries = unreleased;
|
||||
}
|
||||
|
||||
// Prune exclusions
|
||||
if ((!packageName || packageName === 'all') && Array.isArray(exclude) && exclude.length) {
|
||||
const neededPackages = new Set<string>();
|
||||
const excludedReleaseTree: ReleaseEntry[][] = [];
|
||||
|
||||
for (const releaseBranch of releaseTree.reverse()) {
|
||||
const newThisBranch: ReleaseEntry[] = [];
|
||||
|
||||
for (const entry of releaseBranch) {
|
||||
if (exclude.includes(entry.name) && !neededPackages.has(entry.name)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
newThisBranch.push(entry);
|
||||
for (const dep of entry.dependsOn ?? []) {
|
||||
neededPackages.add(dep);
|
||||
}
|
||||
}
|
||||
|
||||
if (newThisBranch.length) excludedReleaseTree.unshift(newThisBranch);
|
||||
}
|
||||
|
||||
return excludedReleaseTree;
|
||||
}
|
||||
|
||||
if (!packageName || packageName === 'all') {
|
||||
return releaseTree;
|
||||
}
|
||||
|
||||
// Prune the tree for the specified package
|
||||
const neededPackages = new Set<string>([packageName]);
|
||||
const packageReleaseTree: ReleaseEntry[][] = [];
|
||||
|
||||
for (const releaseBranch of releaseTree.reverse()) {
|
||||
const newThisBranch: ReleaseEntry[] = [];
|
||||
|
||||
for (const entry of releaseBranch) {
|
||||
if (neededPackages.has(entry.name)) {
|
||||
newThisBranch.push(entry);
|
||||
for (const dep of entry.dependsOn ?? []) {
|
||||
neededPackages.add(dep);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (newThisBranch.length) packageReleaseTree.unshift(newThisBranch);
|
||||
}
|
||||
|
||||
return packageReleaseTree;
|
||||
}
|
||||
Reference in New Issue
Block a user