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): clarify Marketplace publication and channel status (#1797)

Michael D'Angelo3c06dcc1b408
diff --git a/.github/workflows/node-github-release.yml b/.github/workflows/node-github-release.yml
index b85813446..0aa8de4fe 100644
--- a/.github/workflows/node-github-release.yml
+++ b/.github/workflows/node-github-release.yml
@@ -747,15 +747,36 @@ jobs:
if: always()
needs: [release, installed, action, container]
runs-on: ubuntu-latest
+ env:
+ RELEASE_RESULT: ${{ needs.release.result }}
+ INSTALL_RESULT: ${{ needs.installed.result }}
+ ACTION_RESULT: ${{ needs.action.result }}
+ HAS_ACTION: ${{ needs.release.outputs.has-action }}
+ CONTAINER_RESULT: ${{ needs.container.result }}
+ HAS_CONTAINER: ${{ needs.release.outputs.has-container }}
steps:
- - name: Require completed release channels
+ - name: Summarize release channels
+ continue-on-error: true
env:
- RELEASE_RESULT: ${{ needs.release.result }}
- INSTALL_RESULT: ${{ needs.installed.result }}
- ACTION_RESULT: ${{ needs.action.result }}
- HAS_ACTION: ${{ needs.release.outputs.has-action }}
- CONTAINER_RESULT: ${{ needs.container.result }}
- HAS_CONTAINER: ${{ needs.release.outputs.has-container }}
+ RELEASE_VERSION: ${{ needs.release.outputs.version }}
+ run: |
+ {
+ printf '## Release publication status\n\n'
+ printf '| Channel | Result |\n| --- | --- |\n'
+ printf '| npm package and CLI GitHub release | %s |\n' "$RELEASE_RESULT"
+ printf '| Published package installation checks | %s |\n' "$INSTALL_RESULT"
+ printf '| GitHub Action release | %s |\n' "$ACTION_RESULT"
+ printf '| GitHub Marketplace | Not checked; publish and verify separately |\n'
+ printf '| Container image | %s |\n\n' "$CONTAINER_RESULT"
+ if [[ "$HAS_ACTION" == true && "$ACTION_RESULT" == success ]]; then
+ printf 'Marketplace: [edit the Action release](%s/%s/releases/edit/action-v%s) to publish or verify its listing.\n\n' \
+ "$GITHUB_SERVER_URL" "$GITHUB_REPOSITORY" "$RELEASE_VERSION"
+ fi
+ printf 'See the [release process](%s/%s/blob/main/RELEASING.md#publish-to-github-marketplace) for Marketplace publication.\n' \
+ "$GITHUB_SERVER_URL" "$GITHUB_REPOSITORY"
+ } >> "$GITHUB_STEP_SUMMARY"
+
+ - name: Require completed release channels
run: |
test "$RELEASE_RESULT" = success
test "$INSTALL_RESULT" = success
diff --git a/RELEASING.md b/RELEASING.md
index 360e8b82e..028541b1f 100644
--- a/RELEASING.md
+++ b/RELEASING.md
@@ -292,9 +292,15 @@ registry errors fail immediately.
do not prepare a release by editing or committing files there.
Monitor all three workflows and the final status in `node-github-release`.
-A release is complete when npm and GitHub publication, exact-version install
-checks, and applicable Action and container publication have succeeded. The
-protected npm publication gates and immutable `npm-vX.Y.Z` tag remain in place.
+The automated release is complete when npm and GitHub publication, exact-version
+install checks, and applicable Action and container publication have succeeded.
+The final job summarizes each result and identifies Marketplace publication as a
+separate step. A successful workflow does not confirm a Marketplace listing.
+The protected npm publication gates and immutable `npm-vX.Y.Z` tag remain in place.
+
+The npm package and CLI GitHub release become public before the installation and
+Action and container checks finish. Use the final workflow result before
+announcing that the automated release is complete.
After the installed-package checks pass, `node-github-release` calls
`container-release` with the verified npm version and source commit. Native
@@ -316,6 +322,33 @@ Standalone `container-vX.Y.Z` and manual `container-release` triggers remain
available.
See [Container releases](docker/README.md) for publication and verification.
+## Publish to GitHub Marketplace
+
+Publishing the companion `action-vX.Y.Z` GitHub Release does not publish its
+Marketplace listing. Complete this step separately for each Action version
+that should appear in Marketplace:
+
+1. Wait for `node-github-release` to succeed for the version.
+2. Open the existing `action-vX.Y.Z` release and choose **Edit**. Select
+ **Publish this Action to the GitHub Marketplace**. Use the Action release,
+ whose tag contains the tested distribution, rather than the `npm-vX.Y.Z`
+ source release or a new tag on `main`.
+3. Confirm the metadata checks pass. The Marketplace display name comes from
+ `name` in the tagged `action.yml`, currently **OpenAI Codex Security**.
+ GitHub requires a globally unique Action name. If a released version's name
+ is rejected, correct the source metadata and publish a new version; do not
+ move an existing release tag.
+4. Select **Security** as the primary category and **Code review** as the
+ optional secondary category. Confirm the security contact and complete any
+ organization-owned Marketplace agreement requirements.
+5. Review the listing details, keep the Action release unmarked as **Latest**,
+ and choose **Update release**. Verify that the public Marketplace page links
+ to this repository and offers the intended `action-vX.Y.Z` version.
+
+Changing the Marketplace display name does not change the repository reference
+used by workflows or the npm package name. Existing releases retain their tagged
+metadata. See [GitHub's Marketplace publishing requirements](https://docs.github.com/en/actions/how-tos/create-and-publish-actions/publish-in-github-marketplace).
+
## Verify
Check the published state before announcing the release:
diff --git a/action.yml b/action.yml
index 664b1ccd7..4ec08d4fd 100644
--- a/action.yml
+++ b/action.yml
@@ -1,4 +1,4 @@
-name: Codex Security
+name: OpenAI Codex Security
description: Scan code with Codex Security, enforce findings policy, and produce JSON, coverage, and SARIF reports.
branding:
icon: shield
diff --git a/sdk/typescript/tests-ts/action-release-workflow.test.ts b/sdk/typescript/tests-ts/action-release-workflow.test.ts
index 1e844f89a..a2b83450a 100644
--- a/sdk/typescript/tests-ts/action-release-workflow.test.ts
+++ b/sdk/typescript/tests-ts/action-release-workflow.test.ts
@@ -24,6 +24,7 @@ type Step = {
};
type Job = {
steps: Step[];
+ env?: Record<string, string>;
permissions?: Record<string, string>;
needs?: string[];
outputs?: Record<string, string>;
@@ -57,6 +58,7 @@ const reuse = script(
const detect = script("release", "Detect Action release source");
const detectContainer = script("release", "Detect container release source");
const complete = script("complete", "Require completed release channels");
+const summarize = script("complete", "Summarize release channels");
const publish = script("action", "Publish immutable Action tag and metadata");
const directories: string[] = [];
const version = "99.1.2";
@@ -947,3 +949,36 @@ test.each([
expect(result.status === 0).toBe(succeeds);
},
);
+
+test.each(["success", "failure", "cancelled", "skipped"])(
+ "reports the coordinated container result: %s",
+ (containerResult) => {
+ const release = fixture();
+ const summary = join(release.directory, "summary.md");
+ const result = release.run(summarize, {
+ GITHUB_STEP_SUMMARY: summary.replaceAll("\\", "/"),
+ GITHUB_SERVER_URL: "https://github.com",
+ GITHUB_REPOSITORY: "example/project",
+ RELEASE_RESULT: "success",
+ INSTALL_RESULT: "success",
+ ACTION_RESULT: "success",
+ HAS_ACTION: "true",
+ CONTAINER_RESULT: containerResult,
+ HAS_CONTAINER: "true",
+ });
+ expect(result.status, result.stderr).toBe(0);
+ const rows = readFileSync(summary, "utf8")
+ .split("\n")
+ .filter((line) => line.startsWith("|"))
+ .map((line) => line.split("|").map((cell) => cell.trim()));
+ expect(rows.find((row) => row[1] === "Container image")?.[2]).toBe(
+ containerResult,
+ );
+ expect(
+ step("complete", "Summarize release channels")["continue-on-error"],
+ ).toBe(true);
+ expect(workflow.jobs["complete"]?.env?.["CONTAINER_RESULT"]).toBe(
+ "${{ needs.container.result }}",
+ );
+ },
+);