Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
23 changes: 22 additions & 1 deletion scripts/release/channels.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,31 @@ export async function verifiedCandidate(version) {
return { manifest, nightlyEnvelope, versionEnvelope };
}

export function candidateRelease(version, runGh = gh) {
const release = JSON.parse(
runGh([
"release",
"view",
`v${version}`,
"--repo",
repository,
"--json",
"tagName,isDraft,isPrerelease"
])
);
if (
release.tagName !== `v${version}` ||
typeof release.isDraft !== "boolean" ||
typeof release.isPrerelease !== "boolean"
)
throw new Error("Candidate release identity is invalid.");
return { draft: release.isDraft, prerelease: release.isPrerelease };
}

async function publish(version) {
const before = api("releases/latest");
const deployBefore = api("git/ref/heads/deploy").object.sha;
const release = api(`releases/tags/v${version}`);
const release = candidateRelease(version);
if (!release.draft && !release.prerelease) throw new Error("This version is already Stable.");
gh([
"release",
Expand Down
40 changes: 40 additions & 0 deletions test/unit/scripts/candidate-release.test.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
import { describe, expect, it, vi } from "vitest";
import { candidateRelease } from "../../../scripts/release/channels.mjs";

describe("candidate release lookup", () => {
it.each([
[true, false],
[false, true],
[false, false]
])("reads draft=%s and prerelease=%s through the draft-aware CLI", (isDraft, isPrerelease) => {
const runGh = vi.fn(() => JSON.stringify({ tagName: "v1.4.0", isDraft, isPrerelease }));
expect(candidateRelease("1.4.0", runGh)).toEqual({ draft: isDraft, prerelease: isPrerelease });
expect(runGh).toHaveBeenCalledWith([
"release",
"view",
"v1.4.0",
"--repo",
"HQBase/hqbase",
"--json",
"tagName,isDraft,isPrerelease"
]);
});

it.each([
{ tagName: "v1.4.1", isDraft: true, isPrerelease: false },
{ tagName: "v1.4.0", isPrerelease: false },
{ tagName: "v1.4.0", isDraft: true }
])("rejects a changed or incomplete release identity", (release) => {
expect(() => candidateRelease("1.4.0", () => JSON.stringify(release))).toThrow(
"identity is invalid"
);
});

it("propagates a missing release without assuming it is a draft", () => {
expect(() =>
candidateRelease("1.4.0", () => {
throw new Error("release not found");
})
).toThrow("release not found");
});
});