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

docs: clarify plugin source ownership (#685)

soyeon-oai6ec373cb5025
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 029ecd821..e00a33b73 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -6,13 +6,17 @@ maintainers.
## How this repository works
-Codex Security is developed in OpenAI's canonical repository and published
-here through a one-way mirror. We can't import pull requests from this
-repository into the canonical source.
+`plugins/codex-security/` is the canonical source for the Codex Security
+plugin. Make plugin changes there.
+
+The npm runtime under `sdk/typescript/_bundled_plugin/` is generated from the
+plugin source by `pnpm run build:plugin` and automatically during `prepack` for
+packages and releases. Do not edit or commit files in that directory. See the
+[SDK testing guide](sdk/typescript/TESTING.md) for the generation and validation
+commands.
Search [existing issues](https://github.com/openai/codex-security/issues)
-before opening a new one. Maintainers can carry accepted changes into the
-canonical source or invite a focused pull request for this public repository.
+before opening a new one.
## Support for open-source projects
@@ -43,8 +47,8 @@ project's maintainers through their security policy.
## Dependency and release maintenance
-Maintainers update package dependencies and the committed lockfile in the
-canonical repository. The public release workflow installs that locked graph,
+Maintainers update package dependencies and committed lockfiles with the
+affected source. The public release workflow installs those locked graphs,
tests the package, and publishes a verified artifact with npm provenance.
GitHub Actions dependencies are maintained separately in this repository.
diff --git a/RELEASING.md b/RELEASING.md
index e49496506..64a6d82d2 100644
--- a/RELEASING.md
+++ b/RELEASING.md
@@ -73,6 +73,11 @@ for that exact commit:
archive before publishing the GitHub release. It prepends the reviewed
summary to GitHub's categorized notes.
+`node-release` generates the npm plugin payload from the canonical source under
+`plugins/codex-security/` during `prepack`. The generated
+`sdk/typescript/_bundled_plugin/` directory is not a committed release input;
+do not prepare a release by editing or committing files there.
+
Monitor all three workflows. A version bump is not a completed release until
the npm package and GitHub release both exist and match the tag.