Skip to content

Swap flub generate changelog and flub vnext generate changelog implementations, move old to legacy #25909

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

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
+379 −108
Draft

Swap flub generate changelog and flub vnext generate changelog implementations, move old to legacy #25909

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9255351
Initial plan
Copilot Nov 24, 2025
5457c7d
Swap changelog command implementations and mark vnext as deprecated
Copilot Nov 24, 2025
736cf72
Update JSDoc comment and regenerate documentation for deprecated vnex…
Copilot Nov 24, 2025
f7b0cc2
Move deprecated changelog command from vnext to deprecated namespace
Copilot Nov 24, 2025
4fded1e
Rename deprecated to legacy and restore vnext command as deprecated
Copilot Nov 24, 2025
a0c118c
Build and regenerate documentation and manifest
Copilot Nov 24, 2025
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
132 changes: 37 additions & 95 deletions build-tools/packages/build-cli/src/commands/generate/changelog.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,49 +3,40 @@
* Licensed under the MIT License.
*/

import { readFile, writeFile } from "node:fs/promises";
import {
type VersionBumpType,
bumpVersionScheme,
isInternalVersionScheme,
} from "@fluid-tools/version-tools";
import { FluidRepo, type Package } from "@fluidframework/build-tools";
import { ux } from "@oclif/core";
import { command as execCommand } from "execa";
import { inc } from "semver";
import { CleanOptions } from "simple-git";
import { parse } from "semver";

import { checkFlags, releaseGroupFlag, semverFlag } from "../../flags.js";
import { setVersion } from "@fluid-tools/build-infrastructure";
import { releaseGroupNameFlag, semverFlag } from "../../flags.js";
// eslint-disable-next-line import/no-internal-modules
import { updateChangelogs } from "../../library/changelogs.js";
// eslint-disable-next-line import/no-internal-modules
import { canonicalizeChangesets } from "../../library/changesets.js";
import { BaseCommand } from "../../library/index.js";
import { isReleaseGroup } from "../../releaseGroups.js";

async function replaceInFile(
search: string,
replace: string,
filePath: string,
): Promise<void> {
const content = await readFile(filePath, "utf8");
const newContent = content.replace(new RegExp(search, "g"), replace);
await writeFile(filePath, newContent, "utf8");
}

export default class GenerateChangeLogCommand extends BaseCommand<
import { BaseCommandWithBuildProject } from "../../library/index.js";

/**
* Generate a changelog for packages based on changesets. Note that this process deletes the changeset files!
*
* The reason we use a search/replace approach to update the version strings in the changelogs is largely because of
* https://github.com/changesets/changesets/issues/595. What we would like to do is generate the changelogs without
* doing version bumping, but that feature does not exist in the changeset tools.
*/
export default class GenerateChangeLogCommand extends BaseCommandWithBuildProject<
typeof GenerateChangeLogCommand
> {
static readonly description = "Generate a changelog for packages based on changesets.";
static readonly description =
"Generate a changelog for packages based on changesets. Note that this process deletes the changeset files!";

static readonly aliases = ["vnext:generate:changelogs"];

static readonly flags = {
releaseGroup: releaseGroupFlag({
required: true,
}),
releaseGroup: releaseGroupNameFlag({ required: true }),
version: semverFlag({
description:
"The version for which to generate the changelog. If this is not provided, the version of the package according to package.json will be used.",
}),
install: checkFlags.install,
...BaseCommand.flags,
...BaseCommandWithBuildProject.flags,
} as const;

static readonly examples = [
Expand All @@ -55,51 +46,24 @@ export default class GenerateChangeLogCommand extends BaseCommand<
},
];

private async processPackage(pkg: Package, bumpType: VersionBumpType): Promise<void> {
const { directory, version: pkgVersion } = pkg;

// This is the version that the changesets tooling calculates by default. It does a bump of the highest semver type
// in the changesets on the current version. We search for that version in the generated changelog and replace it
// with the one that we want.
const changesetsCalculatedVersion = isInternalVersionScheme(pkgVersion)
? bumpVersionScheme(pkgVersion, bumpType, "internal")
: inc(pkgVersion, bumpType);
const versionToUse = this.flags.version?.version ?? pkgVersion;

// Replace the changeset version with the correct version.
await replaceInFile(
`## ${changesetsCalculatedVersion}\n`,
`## ${versionToUse}\n`,
`${directory}/CHANGELOG.md`,
);

// For changelogs that had no changesets applied to them, add in a 'dependency updates only' section.
await replaceInFile(
`## ${versionToUse}\n\n## `,
`## ${versionToUse}\n\nDependency updates only.\n\n## `,
`${directory}/CHANGELOG.md`,
);
}

public async run(): Promise<void> {
const context = await this.getContext();

const gitRoot = context.root;
const buildProject = this.getBuildProject();

const { install, releaseGroup } = this.flags;
const { releaseGroup: releaseGroupName, version: versionOverride } = this.flags;

const releaseGroup = buildProject.releaseGroups.get(releaseGroupName);
if (releaseGroup === undefined) {
this.error("ReleaseGroup is possibly 'undefined'");
this.error(`Can't find release group named '${releaseGroupName}'`, { exit: 1 });
}

const monorepo =
releaseGroup === undefined ? undefined : context.repo.releaseGroups.get(releaseGroup);
if (monorepo === undefined) {
this.error(`Release group ${releaseGroup} not found in repo config`, { exit: 1 });
const releaseGroupRoot = releaseGroup.workspace.directory;
const releaseGroupVersion = parse(releaseGroup.version);
if (releaseGroupVersion === null) {
this.error(`Version isn't a valid semver string: '${releaseGroup.version}'`, {
exit: 1,
});
}

const releaseGroupRoot = monorepo?.directory ?? gitRoot;

// Strips additional custom metadata from the source files before we call `changeset version`,
// because the changeset tools - like @changesets/cli - only work on canonical changesets.
const bumpType = await canonicalizeChangesets(releaseGroupRoot, this.logger);
Expand All @@ -109,32 +73,19 @@ export default class GenerateChangeLogCommand extends BaseCommand<
await execCommand("pnpm exec changeset version", { cwd: releaseGroupRoot });
ux.action.stop();

const packagesToCheck = isReleaseGroup(releaseGroup)
? context.packagesInReleaseGroup(releaseGroup)
: // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
[context.fullPackageMap.get(releaseGroup)!];

if (install) {
const installed = await FluidRepo.ensureInstalled(packagesToCheck);

if (!installed) {
this.error(`Error installing dependencies for: ${releaseGroup}`);
}
}

const repo = await context.getGitRepository();
const packagesToCheck = releaseGroup.packages;

// git add the deleted changesets (`changeset version` deletes them)
await repo.gitClient.add(".changeset/**");
// restore the package versions that were changed by `changeset version`
await setVersion(packagesToCheck, releaseGroupVersion);

// git restore the package.json files that were changed by `changeset version`
await repo.gitClient.raw("restore", "**package.json");
// Extract the version string from the SemVer object if provided
const versionString = versionOverride?.version;

// Calls processPackage on all packages.
ux.action.start("Processing changelog updates");
const processPromises: Promise<void>[] = [];
for (const pkg of packagesToCheck) {
processPromises.push(this.processPackage(pkg, bumpType));
processPromises.push(updateChangelogs(pkg, bumpType, versionString));
}
const results = await Promise.allSettled(processPromises);
const failures = results.filter((p) => p.status === "rejected");
Expand All @@ -146,15 +97,6 @@ export default class GenerateChangeLogCommand extends BaseCommand<
{ exit: 1 },
);
}

// git add the changelog changes
await repo.gitClient.add("**CHANGELOG.md");

// Cleanup: git restore any edits that aren't staged
await repo.gitClient.raw("restore", ".");

// Cleanup: git clean any untracked files
await repo.gitClient.clean(CleanOptions.RECURSIVE + CleanOptions.FORCE);
ux.action.stop();

this.log("Commit and open a PR!");
Expand Down
131 changes: 99 additions & 32 deletions build-tools/packages/build-cli/src/commands/vnext/generate/changelog.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,40 +3,58 @@
* Licensed under the MIT License.
*/

import { readFile, writeFile } from "node:fs/promises";
import {
type VersionBumpType,
bumpVersionScheme,
isInternalVersionScheme,
} from "@fluid-tools/version-tools";
import { FluidRepo, type Package } from "@fluidframework/build-tools";
import { ux } from "@oclif/core";
import { command as execCommand } from "execa";
import { parse } from "semver";
import { inc } from "semver";
import { CleanOptions } from "simple-git";

import { setVersion } from "@fluid-tools/build-infrastructure";
import { releaseGroupNameFlag, semverFlag } from "../../../flags.js";
// eslint-disable-next-line import/no-internal-modules
import { updateChangelogs } from "../../../library/changelogs.js";
import { checkFlags, releaseGroupFlag, semverFlag } from "../../../flags.js";
// eslint-disable-next-line import/no-internal-modules
import { canonicalizeChangesets } from "../../../library/changesets.js";
import { BaseCommandWithBuildProject } from "../../../library/index.js";
import { BaseCommand } from "../../../library/index.js";
import { isReleaseGroup } from "../../../releaseGroups.js";

async function replaceInFile(
search: string,
replace: string,
filePath: string,
): Promise<void> {
const content = await readFile(filePath, "utf8");
const newContent = content.replace(new RegExp(search, "g"), replace);
await writeFile(filePath, newContent, "utf8");
}

/**
* Generate a changelog for packages based on changesets. Note that this process deletes the changeset files!
*
* The reason we use a search/replace approach to update the version strings in the changelogs is largely because of
* https://github.com/changesets/changesets/issues/595. What we would like to do is generate the changelogs without
* doing version bumping, but that feature does not exist in the changeset tools.
* @deprecated This command is deprecated. Use 'flub generate changelog' instead.
*/
export default class GenerateChangeLogCommand extends BaseCommandWithBuildProject<
export default class GenerateChangeLogCommand extends BaseCommand<
typeof GenerateChangeLogCommand
> {
static readonly description =
"Generate a changelog for packages based on changesets. Note that this process deletes the changeset files!";
"[DEPRECATED] Generate a changelog for packages based on changesets. Use 'flub generate changelog' instead.";

static readonly aliases = ["vnext:generate:changelogs"];
static readonly deprecateAliases = true;
static readonly deprecated = {
message: "This command is deprecated. Use 'flub generate changelog' instead.",
};

static readonly flags = {
releaseGroup: releaseGroupNameFlag({ required: true }),
releaseGroup: releaseGroupFlag({
required: true,
}),
version: semverFlag({
description:
"The version for which to generate the changelog. If this is not provided, the version of the package according to package.json will be used.",
}),
...BaseCommandWithBuildProject.flags,
install: checkFlags.install,
...BaseCommand.flags,
} as const;

static readonly examples = [
Expand All @@ -46,24 +64,51 @@ export default class GenerateChangeLogCommand extends BaseCommandWithBuildProjec
},
];

private async processPackage(pkg: Package, bumpType: VersionBumpType): Promise<void> {
const { directory, version: pkgVersion } = pkg;

// This is the version that the changesets tooling calculates by default. It does a bump of the highest semver type
// in the changesets on the current version. We search for that version in the generated changelog and replace it
// with the one that we want.
const changesetsCalculatedVersion = isInternalVersionScheme(pkgVersion)
? bumpVersionScheme(pkgVersion, bumpType, "internal")
: inc(pkgVersion, bumpType);
const versionToUse = this.flags.version?.version ?? pkgVersion;

// Replace the changeset version with the correct version.
await replaceInFile(
`## ${changesetsCalculatedVersion}\n`,
`## ${versionToUse}\n`,
`${directory}/CHANGELOG.md`,
);

// For changelogs that had no changesets applied to them, add in a 'dependency updates only' section.
await replaceInFile(
`## ${versionToUse}\n\n## `,
`## ${versionToUse}\n\nDependency updates only.\n\n## `,
`${directory}/CHANGELOG.md`,
);
}

public async run(): Promise<void> {
const buildProject = this.getBuildProject();
const context = await this.getContext();

const gitRoot = context.root;

const { releaseGroup: releaseGroupName, version: versionOverride } = this.flags;
const { install, releaseGroup } = this.flags;

const releaseGroup = buildProject.releaseGroups.get(releaseGroupName);
if (releaseGroup === undefined) {
this.error(`Can't find release group named '${releaseGroupName}'`, { exit: 1 });
this.error("ReleaseGroup is possibly 'undefined'");
}

const releaseGroupRoot = releaseGroup.workspace.directory;
const releaseGroupVersion = parse(releaseGroup.version);
if (releaseGroupVersion === null) {
this.error(`Version isn't a valid semver string: '${releaseGroup.version}'`, {
exit: 1,
});
const monorepo =
releaseGroup === undefined ? undefined : context.repo.releaseGroups.get(releaseGroup);
if (monorepo === undefined) {
this.error(`Release group ${releaseGroup} not found in repo config`, { exit: 1 });
}

const releaseGroupRoot = monorepo?.directory ?? gitRoot;

// Strips additional custom metadata from the source files before we call `changeset version`,
// because the changeset tools - like @changesets/cli - only work on canonical changesets.
const bumpType = await canonicalizeChangesets(releaseGroupRoot, this.logger);
Expand All @@ -73,19 +118,32 @@ export default class GenerateChangeLogCommand extends BaseCommandWithBuildProjec
await execCommand("pnpm exec changeset version", { cwd: releaseGroupRoot });
ux.action.stop();

const packagesToCheck = releaseGroup.packages;
const packagesToCheck = isReleaseGroup(releaseGroup)
? context.packagesInReleaseGroup(releaseGroup)
: // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
[context.fullPackageMap.get(releaseGroup)!];

// restore the package versions that were changed by `changeset version`
await setVersion(packagesToCheck, releaseGroupVersion);
if (install) {
const installed = await FluidRepo.ensureInstalled(packagesToCheck);

// Extract the version string from the SemVer object if provided
const versionString = versionOverride?.version;
if (!installed) {
this.error(`Error installing dependencies for: ${releaseGroup}`);
}
}

const repo = await context.getGitRepository();

// git add the deleted changesets (`changeset version` deletes them)
await repo.gitClient.add(".changeset/**");

// git restore the package.json files that were changed by `changeset version`
await repo.gitClient.raw("restore", "**package.json");

// Calls processPackage on all packages.
ux.action.start("Processing changelog updates");
const processPromises: Promise<void>[] = [];
for (const pkg of packagesToCheck) {
processPromises.push(updateChangelogs(pkg, bumpType, versionString));
processPromises.push(this.processPackage(pkg, bumpType));
}
const results = await Promise.allSettled(processPromises);
const failures = results.filter((p) => p.status === "rejected");
Expand All @@ -97,6 +155,15 @@ export default class GenerateChangeLogCommand extends BaseCommandWithBuildProjec
{ exit: 1 },
);
}

// git add the changelog changes
await repo.gitClient.add("**CHANGELOG.md");

// Cleanup: git restore any edits that aren't staged
await repo.gitClient.raw("restore", ".");

// Cleanup: git clean any untracked files
await repo.gitClient.clean(CleanOptions.RECURSIVE + CleanOptions.FORCE);
ux.action.stop();

this.log("Commit and open a PR!");
Expand Down