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

Đang mở
#131 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
42/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
github-actions, typescript
Lĩnh vực
devops

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
TypeScript
Star
0
Fork
0
Merge trung bình
6 giờ
Pull request đã merge (30 ngày)
118

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của promplate/code-review

Tất cả issue của promplate/code-review

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.