chore: automate Rust crate versioning in publish-ci by janechu · Pull Request #7425 · microsoft/fast

janechu · 2026-04-10T18:35:14Z

Pull Request

📖 Description

When npm run publish-ci runs, it now also handles the microsoft-fast-build Rust crate automatically via a new build/publish-rust.mjs script.

This is a revised version of #7373 that addresses all review comments.

Changes

`build/publish-rust.mjs` (new)

A Node.js script that:

Finds the latest Beachball-generated tag matching microsoft-fast-build_v* using git tag --list --sort=-version:refname, falling back to all history if none exists
Inspects git commits touching crates/microsoft-fast-build/ since that tag
Determines the version bump type using conventional commits:
- BREAKING CHANGE / feat!: / fix!: / refactor!: / chore!: → major
- feat: → minor
- anything else → patch
Updates the version in crates/microsoft-fast-build/Cargo.toml
Runs cargo package and copies the .crate file to publish_artifacts/cargo/
Exits cleanly (no-op) if no relevant commits are found since the last release

`package.json`

Updated publish-ci to run the Rust script before beachball:

node build/publish-rust.mjs && beachball publish -y --no-publish

`build/README.md` and `build/DESIGN.md` (new)

Added documentation for the build utilities workspace.

Behavior

Scenario	Result
Commits touch `crates/microsoft-fast-build/`	Version bumped, crate packaged to `publish_artifacts/cargo/`
No commits to crate since last tag	Script exits cleanly, no changes

This mirrors the existing pattern: beachball → publish_artifacts/ (npm), new script → publish_artifacts/cargo/ (Rust).

Review comments addressed from #7373

Header comment mismatch: Updated doc comment to document all major bump triggers (refactor!:, chore!:)
Output directory: Changed from publish_artifacts_cargo/ to publish_artifacts/cargo/ (covered by existing .gitignore entry for publish_artifacts/)
Tag format alignment: Consistent use of {package-name}_v{version} (underscore) format throughout
Script ordering: Rust script runs before beachball so the Cargo.toml version bump is captured in the commit
Tag lookup: Uses git tag --list --sort=-version:refname instead of constructing tag from Cargo.toml version

🎫 Issues

Supersedes #7373

👩‍💻 Reviewer Notes

No .gitignore changes are needed because publish_artifacts/ is already ignored and publish_artifacts/cargo/ falls under that pattern.

The script runs before beachball in publish-ci so the Cargo.toml version bump is included in the beachball commit.

📑 Test Plan

All existing tests pass (10917 pass, 0 fail)
npm run build succeeds
Biome formatting/linting passes
No change files required (this is a build tooling change, not a package change)

✅ Checklist

General

I have included a change request file using $ npm run change
I have added tests for my changes.
I have tested my changes.
I have updated the project documentation to reflect my changes.
I have read the CONTRIBUTING documentation and followed the standards for this project.

⏭ Next Steps

Close chore: automate Rust crate versioning in publish-ci #7373 once this PR is merged
Validate the script in a real CI publish run
Consider adding unit tests for the conventional commit parsing logic

Add build/publish-rust.mjs to bump the microsoft-fast-build Rust crate version based on conventional commits since the last Beachball tag, then package the crate into publish_artifacts/cargo/. Address review comments from PR #7373: - Use publish_artifacts/cargo/ (covered by existing .gitignore entry) - Align tag format documentation to underscore convention - Run Rust script before beachball to capture Cargo.toml bump in commit - Use git tag --list for tag discovery instead of version construction Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Automates Rust crate version bumping + packaging during npm run publish-ci so the microsoft-fast-build crate is versioned and exported to publish_artifacts/cargo/ alongside existing Beachball npm artifacts.

Changes:

Add build/publish-rust.mjs to compute bump from conventional commits since last Beachball tag, update Cargo.toml, and cargo package the crate into publish_artifacts/cargo/.
Update root publish-ci to run the Rust publishing step before beachball publish.
Document build tooling workspace behavior and design rationale in build/README.md and build/DESIGN.md.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.

File	Description
package.json	Chains Rust publishing automation before Beachball in `publish-ci`.
build/publish-rust.mjs	Implements tag lookup, conventional-commit bumping, Cargo.toml update, and artifact packaging.
build/README.md	Documents usage and behavior of build utility scripts, including `publish-rust.mjs`.
build/DESIGN.md	Captures design decisions and data flow for the Rust publishing automation.

Copilot · 2026-04-14T23:17:54Z

build/publish-rust.mjs

+
+    if (
+        /BREAKING CHANGE/m.test(commits) ||
+        /^(feat|fix|refactor|chore)!(\([^)]*\))?:/m.test(commits)


The type! regex does not match the conventional-commits breaking syntax type(scope)!: (the ! comes after the optional scope). As written, it matches feat!(scope): but will miss common messages like feat(parser)!: ..., causing a major bump to be incorrectly downgraded. Update the pattern to match type(scope)!: (and optionally type!:) correctly.

Suggested change

/^(feat|fix|refactor|chore)!($[^)]*$)?:/m.test(commits)

/^(feat|fix|refactor|chore)($[^)]*$)?!:/m.test(commits)

Copilot · 2026-04-14T23:17:54Z

build/publish-rust.mjs

+function updateCargoToml(newVersion) {
+    let content = readFileSync(cargoTomlPath, "utf-8");
+    content = content.replace(/^(version\s*=\s*)"[^"]+"/m, `$1"${newVersion}"`);
+    writeFileSync(cargoTomlPath, content);
+}


This replacement updates the first line starting with version = ... anywhere in the file, which can be incorrect if a dependency table (or another section) appears before [package] and contains version = "...". Consider either parsing TOML and updating [package].version, or restricting the edit to the [package] section (e.g., find the [package] header and only replace version until the next header).

Copilot · 2026-04-14T23:17:55Z

build/publish-rust.mjs

+function packageCrate(version) {
+    mkdirSync(outputDir, { recursive: true });
+    execSync(
+        `cargo package --manifest-path "${cargoTomlPath}" --no-verify --allow-dirty`,
+        { stdio: "inherit" },
+    );
+    const targetPackageDir = join(crateDir, "target", "package");


cargo package may place artifacts under the workspace/global target directory (commonly ${repoRoot}/target/package) rather than ${crateDir}/target/package when invoked within a Cargo workspace, which would make the subsequent glob fail even though packaging succeeded. A more robust approach is to resolve Cargo’s target_directory via cargo metadata (or pass an explicit --target-dir) and use that location for target/package.

Suggested change

function packageCrate(version) {

mkdirSync(outputDir, { recursive: true });

execSync(

`cargo package --manifest-path "${cargoTomlPath}" --no-verify --allow-dirty`,

{ stdio: "inherit" },

);

const targetPackageDir = join(crateDir, "target", "package");

function getCargoTargetDirectory() {

const metadataJson = execSync(

`cargo metadata --manifest-path "${cargoTomlPath}" --format-version 1 --no-deps`,

{ encoding: "utf-8" },

);

const metadata = JSON.parse(metadataJson);

if (!metadata.target_directory) {

throw new Error("Could not determine Cargo target_directory from cargo metadata");

}

return metadata.target_directory;

}

function packageCrate(version) {

mkdirSync(outputDir, { recursive: true });

execSync(

`cargo package --manifest-path "${cargoTomlPath}" --no-verify --allow-dirty`,

{ stdio: "inherit" },

);

const targetPackageDir = join(getCargoTargetDirectory(), "package");

Copilot · 2026-04-14T23:17:55Z

build/publish-rust.mjs

+
+    const range = latestTag ? `${latestTag}..HEAD` : "HEAD";
+    const log = execSync(
+        `git -C "${repoRoot}" log ${range} --pretty=format:"%s%n%b" -- crates/microsoft-fast-build/`,


The log format concatenates commits without a guaranteed separator between entries (especially when %b is empty), which can make the bump-detection regexes brittle (anchors with ^/m depend on reliable newlines). Add an explicit delimiter/newline between commits in the pretty format (or use a NUL-delimited format) so each commit boundary is unambiguous during parsing.

Suggested change

`git -C "${repoRoot}" log ${range} --pretty=format:"%s%n%b" -- crates/microsoft-fast-build/`,

`git -C "${repoRoot}" log ${range} --pretty=format:"%s%n%b%n%n" -- crates/microsoft-fast-build/`,

Copilot · 2026-04-14T23:17:55Z

build/publish-rust.mjs

+    execSync(
+        `cargo package --manifest-path "${cargoTomlPath}" --no-verify --allow-dirty`,
+        { stdio: "inherit" },
+    );


If cargo is unavailable/misconfigured in the environment, execSync will throw with a generic stack trace that’s hard to diagnose from CI logs. Catch the failure and rethrow a targeted error that mentions the exact command and common remediation (e.g., ensuring the Rust toolchain is installed and cargo is on PATH), so publish failures are actionable.

Suggested change

execSync(

`cargo package --manifest-path "${cargoTomlPath}" --no-verify --allow-dirty`,

{ stdio: "inherit" },

);

const cargoPackageCommand = `cargo package --manifest-path "${cargoTomlPath}" --no-verify --allow-dirty`;

try {

execSync(cargoPackageCommand, { stdio: "inherit" });

} catch (error) {

throw new Error(

`Failed to run '${cargoPackageCommand}'. Ensure the Rust toolchain is installed and 'cargo' is available on PATH before publishing.`,

{ cause: error },

);

}

janechu mentioned this pull request Apr 14, 2026

chore: automate Rust crate versioning in publish-ci #7373

Closed

janechu requested a review from Copilot April 14, 2026 23:11

Copilot AI reviewed Apr 14, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: automate Rust crate versioning in publish-ci#7425

chore: automate Rust crate versioning in publish-ci#7425
janechu wants to merge 1 commit intomainfrom
users/janechu/fix-pr-for-version-bump-rust-crate

janechu commented Apr 10, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 14, 2026

Uh oh!

Copilot AI Apr 14, 2026

Uh oh!

Copilot AI Apr 14, 2026

Uh oh!

Copilot AI Apr 14, 2026

Uh oh!

Copilot AI Apr 14, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	/^(feat\|fix\|refactor\|chore)!(\([^)]*\))?:/m.test(commits)
	/^(feat\|fix\|refactor\|chore)(\([^)]*\))?!:/m.test(commits)

	`git -C "${repoRoot}" log ${range} --pretty=format:"%s%n%b" -- crates/microsoft-fast-build/`,
	`git -C "${repoRoot}" log ${range} --pretty=format:"%s%n%b%n%n" -- crates/microsoft-fast-build/`,

-    execSync(
-        `cargo package --manifest-path "${cargoTomlPath}" --no-verify --allow-dirty`,
-        { stdio: "inherit" },
-    );
+    const cargoPackageCommand = `cargo package --manifest-path "${cargoTomlPath}" --no-verify --allow-dirty`;
+    try {
+        execSync(cargoPackageCommand, { stdio: "inherit" });
+    } catch (error) {
+        throw new Error(
+            `Failed to run '${cargoPackageCommand}'. Ensure the Rust toolchain is installed and 'cargo' is available on PATH before publishing.`,
+            { cause: error },
+        );
+    }

Conversation

janechu commented Apr 10, 2026

Pull Request

📖 Description

Changes

build/publish-rust.mjs (new)

package.json

build/README.md and build/DESIGN.md (new)

Behavior

Review comments addressed from #7373

🎫 Issues

👩‍💻 Reviewer Notes

📑 Test Plan

✅ Checklist

General

⏭ Next Steps

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 14, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

`build/publish-rust.mjs` (new)

`package.json`

`build/README.md` and `build/DESIGN.md` (new)