Skip to content

OpenAI's Codex Security CLI and TypeScript SDK for finding, validating, and fixing security vulnerabilities. npm: https://www.npmjs.com/package/@openai/codex-security

fix(release): preserve generated-note command failures (#1729)

Michael D'Angelo59cd2253b72c
diff --git a/sdk/typescript/scripts/publish-github-release.mjs b/sdk/typescript/scripts/publish-github-release.mjs
index de3c0f9ca..3e30efcc2 100644
--- a/sdk/typescript/scripts/publish-github-release.mjs
+++ b/sdk/typescript/scripts/publish-github-release.mjs
@@ -147,10 +147,9 @@ export function publishGitHubRelease(env, workspace, run = runCommand) {
notesArgs.push("-f", "configuration_file_path=.github/release.yml");
if (previousTag) notesArgs.push("-f", `previous_tag_name=${previousTag}`);
const generatedResult = run("gh", notesArgs);
- const generated = JSON.parse(generatedResult.stdout);
+ const generated = JSON.parse(output(generatedResult));
if (typeof generated.body !== "string")
throw new Error("Generated GitHub release notes must be a string.");
- output(generatedResult);
const tagged = run(
"git",
["show", `${sha}:.github/release-notes.md`],
diff --git a/sdk/typescript/tests-ts/release-automation.test.ts b/sdk/typescript/tests-ts/release-automation.test.ts
index ea87786b9..0d0efa0bb 100644
--- a/sdk/typescript/tests-ts/release-automation.test.ts
+++ b/sdk/typescript/tests-ts/release-automation.test.ts
@@ -67,6 +67,11 @@ function runPublisher({
existingLookup = "existing",
existingNotes = "Generated release notes",
generatedNotes = "Generated release notes\n",
+ generateNotesResult = {
+ status: 0,
+ stdout: JSON.stringify({ body: generatedNotes }),
+ stderr: "",
+ },
latestTag = "npm-v0.1.3",
makeLatest = false,
@@ -151,12 +156,9 @@ function runPublisher({
expect(
args.includes("configuration_file_path=.github/release.yml"),
).toBe(releaseConfiguration);
- return {
- status: 0,
- stdout: JSON.stringify({
- body: generatedNotes,
- }),
- };
+ if (generateNotesResult.stderr)
+ console.error(generateNotesResult.stderr);
+ return generateNotesResult;
}
}
if (program === "git" && args[0] === "cat-file")
@@ -3062,6 +3064,25 @@ describe("GitHub release workflow safeguards", () => {
expect(githubReleaseWorkflow).toContain("release-history");
});
+ test.each(["", "not-json"])(
+ "preserves note-generation failure before parsing %j output",
+ (stdout) => {
+ const result = runPublisher({
+ existingLookup: "missing",
+ generateNotesResult: {
+ status: 17,
+ stdout,
+ stderr: "Release notes are unavailable.",
+ },
+ });
+ expect(result.status).toBe(17);
+ expect(result.stderr).toBe("Release notes are unavailable.\n");
+ expect(result.calls.at(-1)).toContain(
+ "repos/test/codex-security/releases/generate-notes",
+ );
+ },
+ );
+
test("generates notes only from a previously published release", () => {
expect(githubReleaseWorkflow).toContain(
"npm view @openai/codex-security versions",