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

オープン
#131 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
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時間
マージ済み PR(30日)
118

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

promplate/code-review のほかの issue

promplate/code-review の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。