OpenAI's Codex Security CLI and TypeScript SDK for finding, validating, and fixing security vulnerabilities. npm: https://www.npmjs.com/package/@openai/codex-security
TypeScript ai-securityapplication-securityclicode-scanningcodexcodex-securitycybersecuritydevsecopsnodejsnpmopenaisdksecuritytypescriptvulnerability-scanning
fix(release): use versioned conventional commit titles (#879)
mldangelo-oai5851c8e41ee3
diff --git a/.github/workflows/node-release-labels.yml b/.github/workflows/node-release-labels.ymlindex ae185d275..468dae3a0 100644--- a/.github/workflows/node-release-labels.yml+++ b/.github/workflows/node-release-labels.yml@@ -32,7 +32,7 @@ jobs:set -euo pipefailrelease_note_label() {- local type="$1" breaking_marker="$2"+ local type="$1" breaking_marker="$2" scope="$3"if [[ "$breaking_marker" == "!" ]]; thenprintf '%s\n' breaking-changereturn 0@@ -51,6 +51,11 @@ jobs:release | test)printf '%s\n' skip-release-notes;;+ chore)+ if [[ "$scope" == "(release)" ]]; then+ printf '%s\n' skip-release-notes+ fi+ ;;*)return 0;;@@ -78,8 +83,9 @@ jobs:exit 1fitype="${BASH_REMATCH[1]}"+ scope="${BASH_REMATCH[2]:-}"breaking_marker="${BASH_REMATCH[3]:-}"- label="$(release_note_label "$type" "$breaking_marker")"+ label="$(release_note_label "$type" "$breaking_marker" "$scope")"current_labels="$(gh api "repos/$GITHUB_REPOSITORY/issues/$PR_NUMBER/labels" \--jq '.[].name'diff --git a/RELEASING.md b/RELEASING.mdindex fc364ebb9..8255be0db 100644--- a/RELEASING.md+++ b/RELEASING.md@@ -28,18 +28,20 @@ feat(sdk)!: remove the legacy result fieldThe title controls the generated release category:-| Title | Release category |-| ----------------- | ---------------- |-| Any type with `!` | Breaking changes |-| `feat` | Features |-| `fix` | Fixes |-| `docs` | Documentation |-| `release`, `test` | Excluded |-| Any other type | Other changes |--Use `release` and `test` only for changes that do not affect package users. A-maintainer can apply `skip-release-notes` to exclude another internal change.-That manual label takes precedence over the title category.+| Title | Release category |+| ----------------------------------- | ---------------- |+| Any type with `!` | Breaking changes |+| `feat` | Features |+| `fix` | Fixes |+| `docs` | Documentation |+| `chore(release)`, `release`, `test` | Excluded |+| Any other type | Other changes |++Use `chore(release)` for release preparation and `test` for test-only changes.+The legacy `release` type remains supported. Use these only for changes that+do not affect package users. A maintainer can apply `skip-release-notes` to+exclude another internal change. That manual label takes precedence over the+title category.## Version policy before 1.0@@ -67,9 +69,12 @@ once a change reaches `main` after the current package version. It recomputesthe proposal's version from all changes since that package version firstreached `main`. Squash-merge release PRs, as required by thisrepository's enabled merge method, so the whole proposal lands as one-release boundary commit. A later breaking change changes the version on the-same PR. Each update incorporates the latest `main` and appends a commit;-the updater never force-pushes. A concurrent commit causes it to reread and+release boundary commit. Generated PR titles and commit subjects use+`chore(release): X.Y.Z`, matching the proposed package version. Confirm the+squash commit subject uses the current PR title when merging. A later breaking+change updates the version and title on the same PR. Each update incorporates+the latest `main` and appends a commit; the updater never force-pushes.+A concurrent commit causes it to reread andretry. It requests Codex review when the proposal files change. Updates thatonly incorporate `main` keep CI current without repeating the same proposalreview. New suggestions for human-owned notes still appear in a comment.@@ -86,9 +91,10 @@ reach `main` before opening the next proposal. An empty release cycle returns`action: "unchanged"` without creating a branch or PR. Publication of theprevious version still has to complete and pass the verification steps below.-The updater leaves another open `release:` PR targeting `main`, including a-manually prepared release, untouched and does not open a duplicate. Finish-or close that PR before enabling the new flow. Closing an automated proposal+The updater leaves another open `chore(release):` or legacy `release:` PR+targeting `main`, including a manually prepared release, untouched and does not+open a duplicate. Finish or close that PR before enabling the new flow.+Closing an automated proposalpauses its cycle; reopen it to resume. Retargeting it away from `main` alsopauses updates; restore its `main` base before resuming. Both ready proposalsand existing drafts receive updates. Existing drafts can be marked ready@@ -177,7 +183,7 @@ Generated PRs leave the disclosure attestations unchecked for maintainer review.compatibility work, link relevant public documentation, and leave thepull-request inventory to the generated section.4. Open a pull request with a strict Conventional Commit title such as- `release: bump Codex Security to 0.2.0`.+ `chore(release): 0.2.0`.5. Run the checks required by the changed files and record the results in thepull request. Do not merge until required CI, review, and public disclosurechecks pass on the current commit.diff --git a/sdk/typescript/scripts/release-pr.mjs b/sdk/typescript/scripts/release-pr.mjsindex 857dfa634..cb899f773 100644--- a/sdk/typescript/scripts/release-pr.mjs+++ b/sdk/typescript/scripts/release-pr.mjs@@ -11,18 +11,22 @@ export const statePath = ".github/release-pr-state.json";const templatePath = ".github/PULL_REQUEST_TEMPLATE.md";const sectionIds = ["highlights", "upgrades"];const releaseBranchPrefix = "release/next-";-const conventionalTitle = /^([a-z][a-z0-9-]*)(?:\([^)]*\))?(!)?: (.+)$/u;+const conventionalTitle = /^([a-z][a-z0-9-]*)(?:\(([^)]*)\))?(!)?: (.+)$/u;++function isReleaseTitle(title) {+ const [, type, scope] = conventionalTitle.exec(title) ?? [];+ return type === "release" || (type === "chore" && scope === "release");+}function isReleasePull(pull) {return (- conventionalTitle.exec(pull.title)?.[1] === "release" ||- pull.head.ref.startsWith(releaseBranchPrefix)+ isReleaseTitle(pull.title) || pull.head.ref.startsWith(releaseBranchPrefix));}export function isBreakingChange(change) {return (- conventionalTitle.exec(change.title)?.[2] === "!" ||+ conventionalTitle.exec(change.title)?.[3] === "!" ||/^(?:BREAKING CHANGE|BREAKING-CHANGE):\s+\S/mu.test(change.body ?? "") ||(change.labels ?? []).includes("breaking-change"));@@ -47,7 +51,7 @@ function markdownText(value) {}function changeLine(change) {- const description = conventionalTitle.exec(change.title)?.[3] ?? change.title;+ const description = conventionalTitle.exec(change.title)?.[4] ?? change.title;const reference = change.number? `#${change.number}`: change.sha.slice(0, 7);@@ -59,7 +63,7 @@ function visibleChanges(changes) {const type = conventionalTitle.exec(change.title)?.[1];return (!(change.labels ?? []).includes("skip-release-notes") &&- (change.breaking || !["release", "test"].includes(type))+ (change.breaking || (type !== "test" && !isReleaseTitle(change.title))));});}@@ -206,10 +210,7 @@ export function createReleasePlan(history, previous = null) {mainSha,version,branch: `${releaseBranchPrefix}${baseVersion}`,- title:- changes.length > 0- ? `release: bump Codex Security to ${version}`- : "release: prepare the next Codex Security release",+ title: `chore(release): ${version}`,changes,generated,humanOwned: sectionIds.filter((id) => sections[id].humanOwned),@@ -550,12 +551,13 @@ export async function reconcileReleasePullRequest({dryRun,plan,};- const changed =+ const branchChanged =!headSha ||previous.mergeBase !== mainSha ||Object.entries(plan.files).some(([path, content]) => repo.readFile(headSha, path) !== content,);+ const changed = branchChanged || pull?.title !== plan.title;if (dryRun)return {action: !pull ? "would-create" : changed ? "would-update" : "unchanged",@@ -565,7 +567,7 @@ export async function reconcileReleasePullRequest({let commitSha = headSha;let currentPulls;- if (changed) {+ if (branchChanged) {if ((await branchHead(github, "main")) !== mainSha) continue;const tree = await github.request("POST", "git/trees", {base_tree: repo.git("rev-parse", `${mainSha}^{tree}`).trim(),diff --git a/sdk/typescript/tests-ts/release-automation.test.ts b/sdk/typescript/tests-ts/release-automation.test.tsindex efa925bbb..0cf61cd29 100644--- a/sdk/typescript/tests-ts/release-automation.test.ts+++ b/sdk/typescript/tests-ts/release-automation.test.ts@@ -3862,7 +3862,7 @@ describe("GitHub release workflow safeguards", () => {'gh api "repos/$GITHUB_REPOSITORY/issues/$PR_NUMBER"',);expect(releaseLabelsWorkflow).toContain(- 'label="$(release_note_label "$type" "$breaking_marker")"',+ 'label="$(release_note_label "$type" "$breaking_marker" "$scope")"',);expect(releaseLabelsWorkflow).toContain("breaking-change | enhancement | bug | documentation | skip-release-notes)",@@ -4510,6 +4510,7 @@ describe("GitHub release workflow safeguards", () => {{ title: "fix: publish a customer fix", label: "bug" },{ title: "docs: publish customer documentation", label: "documentation" },{ title: "chore: stop excluding an internal change", label: null },+ { title: "chore(deps): upgrade a dependency", label: null },{ title: "security: publish a security fix", label: null },{ title: "deps: upgrade a dependency", label: null },])(@@ -4583,6 +4584,7 @@ describe("GitHub release workflow safeguards", () => {{ title: "fix!: breaking fix", label: "breaking-change" },{ title: "fix(api)!: breaking fix", label: "breaking-change" },{ title: "docs!: breaking documentation", label: "breaking-change" },+ { title: "chore(release)!: require migration", label: "breaking-change" },{title: "docs(api)!: breaking documentation",label: "breaking-change",@@ -4638,56 +4640,64 @@ describe("GitHub release workflow safeguards", () => {expect(result.stdout).toContain(`labels[]=${label}`);});- test("executes and recovers from concurrent skip-label creation", async () => {- const script = workflowStepShell(- releaseLabelsWorkflow,- "Categorize pull request without checking out its code",- );- const mock = [- "skip_label_exists=0",- "gh() {",- ' if [[ "$1" != "api" ]]; then return 64; fi',- " shift",- " local method=GET",- ' if [[ "${1:-}" == "--method" ]]; then',- ' method="$2"',- " shift 2",- " fi",- ' local endpoint="$1"',- ' case "$method $endpoint" in',- ' "GET repos/test/codex-security/issues/17")',- " printf '%s' 'release: automate published notes' | base64",- " ;;",- ' "GET repos/test/codex-security/issues/17/labels")',- " return 0",- " ;;",- ' "GET repos/test/codex-security/labels/skip-release-notes")',- ' [[ "$skip_label_exists" == 1 ]]',- " ;;",- ' "POST repos/test/codex-security/labels")',- " skip_label_exists=1",- " return 1",- " ;;",- ' "POST repos/test/codex-security/issues/17/labels")',- ' if [[ "$skip_label_exists" != 1 ]]; then return 65; fi',- " printf '%s\\n' 'applied skip-release-notes'",- " ;;",- " *) return 66 ;;",- " esac",- "}",- ].join("\n");- const result = await runCommand(bash, ["-c", `${mock}\n${script}`], {- env: {- ...process.env,- GITHUB_REPOSITORY: "test/codex-security",- PR_NUMBER: "17",- },- timeout: 10_000,- });+ test.each([+ "chore(release): 0.1.24",+ "release: automate published notes",+ "test: extend coverage",+ ])(+ "excludes %s and recovers from concurrent skip-label creation",+ async (title) => {+ const script = workflowStepShell(+ releaseLabelsWorkflow,+ "Categorize pull request without checking out its code",+ );+ const mock = [+ "skip_label_exists=0",+ "gh() {",+ ' if [[ "$1" != "api" ]]; then return 64; fi',+ " shift",+ " local method=GET",+ ' if [[ "${1:-}" == "--method" ]]; then',+ ' method="$2"',+ " shift 2",+ " fi",+ ' local endpoint="$1"',+ ' case "$method $endpoint" in',+ ' "GET repos/test/codex-security/issues/17")',+ " printf '%s' \"$MOCK_PR_TITLE\" | base64",+ " ;;",+ ' "GET repos/test/codex-security/issues/17/labels")',+ " return 0",+ " ;;",+ ' "GET repos/test/codex-security/labels/skip-release-notes")',+ ' [[ "$skip_label_exists" == 1 ]]',+ " ;;",+ ' "POST repos/test/codex-security/labels")',+ " skip_label_exists=1",+ " return 1",+ " ;;",+ ' "POST repos/test/codex-security/issues/17/labels")',+ ' if [[ "$skip_label_exists" != 1 ]]; then return 65; fi',+ " printf '%s\\n' 'applied skip-release-notes'",+ " ;;",+ " *) return 66 ;;",+ " esac",+ "}",+ ].join("\n");+ const result = await runCommand(bash, ["-c", `${mock}\n${script}`], {+ env: {+ ...process.env,+ GITHUB_REPOSITORY: "test/codex-security",+ MOCK_PR_TITLE: title,+ PR_NUMBER: "17",+ },+ timeout: 10_000,+ });- expect(result.status).toBe(0);- expect(result.stdout).toContain("applied skip-release-notes");- });+ expect(result.status).toBe(0);+ expect(result.stdout).toContain("applied skip-release-notes");+ },+ );test("documents JSON stdin for every verification command", async () => {const result = await runCommand(diff --git a/sdk/typescript/tests-ts/release-pr.test.ts b/sdk/typescript/tests-ts/release-pr.test.tsindex f1010601d..06c50871e 100644--- a/sdk/typescript/tests-ts/release-pr.test.ts+++ b/sdk/typescript/tests-ts/release-pr.test.ts@@ -783,6 +783,28 @@ describe("pre-1.0 release policy", () => {).toThrow("policy");});+ test("excludes release preparation while preserving visible and breaking changes", () => {+ const plan = createReleasePlan(+ history([+ change("chore(release): 0.1.24", 1),+ change("release: prepare legacy release", 2),+ change("test: extend coverage", 3),+ change("chore(deps): update dependencies", 4),+ change("docs(release): explain publishing", 5),+ change("chore(release)!: require migration", 6),+ ]),+ );+ expect(plan.version).toBe("0.2.0");+ expect(plan.title).toBe("chore(release): 0.2.0");+ expect(plan.generated.highlights).not.toContain("0.1.24");+ expect(plan.generated.highlights).not.toContain("prepare legacy release");+ expect(plan.generated.highlights).not.toContain("extend coverage");+ expect(plan.generated.highlights).toContain("update dependencies");+ expect(plan.generated.highlights).toContain("explain publishing");+ expect(plan.generated.highlights).toContain("require migration");+ expect(plan.generated.upgrades).toContain("require migration");+ });+test.each([{ format: "compact", indent: undefined },{ format: "indented", indent: 2 },@@ -973,6 +995,7 @@ describe("rolling release reconciliation", () => {const preview = await fixture.run(true);expect(preview.action).toBe("would-create");expect(preview.plan.version).toBe("0.1.24");+ expect(preview.plan.title).toBe("chore(release): 0.1.24");expect(fixture.github.writes).toHaveLength(0);const first = await fixture.run();expect(first.action).toBe("created");@@ -981,6 +1004,10 @@ describe("rolling release reconciliation", () => {(candidate) => candidate.number === first.pull,)!;expect(pull.draft).toBe(false);+ expect(pull.title).toBe("chore(release): 0.1.24");+ expect(+ fixture.git("show", "-s", "--format=%s", first.headSha!).trim(),+ ).toBe("chore(release): 0.1.24");expect(pull.body).toContain("- [ ]");pull.body += "\nMaintainer review and test results.\n";const humanBody = pull.body;@@ -991,6 +1018,10 @@ describe("rolling release reconciliation", () => {expect(second.action).toBe("updated");expect(second.pull).toBe(first.pull);expect(second.plan.version).toBe("0.2.0");+ expect(pull.title).toBe("chore(release): 0.2.0");+ expect(+ fixture.git("show", "-s", "--format=%s", second.headSha!).trim(),+ ).toBe("chore(release): 0.2.0");expect(second.plan.branch).toBe(first.plan.branch);expect(pull.body).toBe(humanBody);expect(@@ -1013,6 +1044,33 @@ describe("rolling release reconciliation", () => {expect(fixture.github.writes).toHaveLength(writes);});+ test("retitles an existing release PR without changing an up-to-date branch", async () => {+ const fixture = new Fixture();+ fixture.merge("fix: initial fix");+ const first = await fixture.run();+ const pull = fixture.github.pulls.find(+ (candidate) => candidate.number === first.pull,+ )!;+ pull.title = "release: prepare the next Codex Security release";+ const body = pull.body;+ const writes = fixture.github.writes.length;+ const preview = await fixture.run(true);+ expect(preview.action).toBe("would-update");+ expect(fixture.github.writes).toHaveLength(writes);+ const updated = await fixture.run();+ expect(updated.action).toBe("updated");+ expect(updated.headSha).toBe(first.headSha);+ expect(pull.title).toBe("chore(release): 0.1.24");+ expect(pull.body).toBe(body);+ expect(fixture.github.writes.slice(writes)).toEqual([+ {+ method: "PATCH",+ path: `pulls/${pull.number}`,+ body: { title: "chore(release): 0.1.24" },+ },+ ]);+ });+test("incorporates main-only changes without another proposal review or repeated commits", async () => {const fixture = new Fixture();fixture.merge("feat: initial feature");@@ -1251,30 +1309,33 @@ describe("rolling release reconciliation", () => {).toBe(false);});- test("does not touch another release PR or recreate an intentionally closed proposal", async () => {- const fixture = new Fixture();- fixture.merge("feat: initial feature");- const manual = fixture.github.addPull(- "manual-release",- "release: prepare a release",- fixture.head()!,- );- const held = await fixture.run();- expect(held.action).toBe("held");- expect(held.reason).toContain(`#${manual.number}`);- expect(fixture.github.writes).toHaveLength(0);- manual.state = "closed";- const created = await fixture.run();- const pull = fixture.github.pulls.find(- (candidate) => candidate.number === created.pull,- )!;- pull.state = "closed";- const writes = fixture.github.writes.length;- expect((await fixture.run()).action).toBe("held");- expect(fixture.github.writes).toHaveLength(writes);- pull.state = "open";- expect((await fixture.run()).pull).toBe(pull.number);- });+ test.each(["chore(release): 0.1.24", "release: prepare a release"])(+ "does not touch another %s PR or recreate an intentionally closed proposal",+ async (title) => {+ const fixture = new Fixture();+ fixture.merge("feat: initial feature");+ const manual = fixture.github.addPull(+ "manual-release",+ title,+ fixture.head()!,+ );+ const held = await fixture.run();+ expect(held.action).toBe("held");+ expect(held.reason).toContain(`#${manual.number}`);+ expect(fixture.github.writes).toHaveLength(0);+ manual.state = "closed";+ const created = await fixture.run();+ const pull = fixture.github.pulls.find(+ (candidate) => candidate.number === created.pull,+ )!;+ pull.state = "closed";+ const writes = fixture.github.writes.length;+ expect((await fixture.run()).action).toBe("held");+ expect(fixture.github.writes).toHaveLength(writes);+ pull.state = "open";+ expect((await fixture.run()).pull).toBe(pull.number);+ },+ );test("does not create a duplicate when a manual release PR opens during preparation", async () => {const fixture = new Fixture();