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

Aperta
#131 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
42/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
github-actions, typescript
Ambito
devops

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
TypeScript
Stelle
0
Fork
0
Merge medio
6h
PR unite (30g)
118

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di promplate/code-review

Tutte le issue di promplate/code-review

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.