How should an API key for a custom provider be supplied?

未关闭
#131 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
42/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
活跃
技术栈
github-actions, typescript
领域
devops

调研方向

Start by reading the action inputs and how review.yml passes them to the Codex process. Trace how codex-config and codex-auth are handled, then check whether the action can expose workflow secrets as environment variables for env_key. Done means the intended credential practice is documented or supported with a clear, secure input path.

由索引模型根据 Issue 内容生成。

描述

Question

The action takes two content inputs, codex-config (a config.toml) and codex-auth (an auth.json). For a custom provider that speaks the Responses API and authenticates with a static API key, neither is an obvious fit:

  • codex-config works, but only by writing the key into [model_providers.<name>].experimental_bearer_token. The Codex config schema says that field is "discouraged in favor of env_key for security reasons, but this may be necessary when using this programmatically".
  • codex-auth is described as "to sign in with ChatGPT instead of an API key", and setting requires_openai_auth = true would make Codex treat the provider as an OpenAI account login rather than a custom endpoint.

env_key looks like the clean answer — the config names a variable, the workflow supplies it from secrets.* — but there is no path to export an environment variable into the action: review.yml exposes no such input, and a caller cannot attach env: to a jobs.<id>.uses: entry.

What I'm asking

Which of these is the intended practice today, and would you consider supporting the standard shape?

  1. Keep writing experimental_bearer_token into codex-config, as the accepted programmatic escape hatch.
  2. Add an input such as codex-env (newline-separated KEY=VALUE pairs exported before Codex runs), so the config can use env_key and the secret never appears in the config text.
  3. Something else entirely — e.g. auth command-backed credentials are meant for this.

Option 2 would let the config.toml live in the repository (or a repository variable, via codex-config-file) while the key stays a workflow secret only.

主要语言
TypeScript
星标
0
派生
0
平均合并
6 小时
30 天内合并 PR
118

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

promplate/code-review 的其他 Issue

查看 promplate/code-review 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。