Skip to content

fix(release): use portable Git paths in release guards #3766

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

Open
dajiaohuang wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −5
Open

fix(release): use portable Git paths in release guards #3766

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
12 changes: 7 additions & 5 deletions scripts/set-version.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
*/

import { existsSync, readFileSync, writeFileSync } from "fs";
import { join } from "path";
import { join, posix } from "path";
import { execFileSync } from "child_process";
import { pathToFileURL } from "url";
import { CLI_SEMVER_PATTERN } from "./cli-options.ts";
Expand Down Expand Up @@ -259,7 +259,8 @@ export function missingChangelogArtifacts(version: string) {
}

export function changelogArtifacts(version: string) {
return [join("releases", `v${version}.md`), `docs/changelog.mdx#HyperFrames v${version}`];
// Git paths are always slash-separated, including when release tooling runs on Windows.
return [posix.join("releases", `v${version}.md`), `docs/changelog.mdx#HyperFrames v${version}`];
}

export function unreviewedChangelogArtifacts(version: string) {
Expand Down Expand Up @@ -310,10 +311,11 @@ export function docsChangelogEntryHasGeneratedTodo(content: string, marker: stri

export function releaseAllowedPaths(version: string) {
return [
...PACKAGES.map((pkg) => join(pkg, "package.json")),
...PLUGINS.map((plugin) => join(plugin, "plugin.json")),
// These values are compared with Git's slash-separated path output.
...PACKAGES.map((pkg) => posix.join(pkg, "package.json")),
...PLUGINS.map((plugin) => posix.join(plugin, "plugin.json")),
"docs/changelog.mdx",
join("releases", `v${version}.md`),
posix.join("releases", `v${version}.md`),
];
}

Expand Down