codex-action

在 GitHub 流水线里自动跑 AI 编码任务

开源 🏷️完全免费 🔧 仅开源项目,无在线服务,需自行部署 编程开发 🍴 复刻 188 🐛 待处理 81 👀 关注 12
GitHub ↗
GitHub 星标 ★ 1310
维护状态 活跃
是否开源 开源
定价模式 🏷️完全免费 开源免费

项目预览

codex-action 项目界面预览图
图片来源:GitHub 官方仓库名片

项目数据

分类编程开发
开发团队openai
定价模式🏷️完全免费
价格说明开源免费
访问状态🔧 仅开源项目,无在线服务,需自行部署
是否开源是
开源协议Apache-2.0
主要语言JavaScript
GitHub 星标★ 1310
上线时间2025-10-01 00:00:00
代码更新2026-11-18
仓库体积15.2 MB
本站数据更新2026-11-23
维护状态活跃
收录时间2026-11-23
浏览次数0

项目介绍

codex-action 是一个基于 JavaScript 的 GitHub Action,用于在 CI/CD 流程中自动调用 Codex 类 AI 编码代理完成代码任务。它解决的是把 AI 编程能力从本地编辑器延伸到仓库自动化的问题:开发者可在 issue、PR 或定时任务触发时,让代理读取仓库上下文、生成或修改代码、执行命令并提交结果。核心能力包括在 Action 中配置提示词与运行参数、与 GitHub 事件联动、自动创建分支或 PR、把执行日志回写到工作流,从而把重复性编码、修复、文档更新等工作交给流水线。项目体量轻、接入门槛低,适合已有 GitHub Actions 基础的团队快速试验 AI 自动化编码。

Star 增长趋势

本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整

数据来源:GitHub API 逐日快照 · 收录于 2026-11-23 · 当前星标 ★ 1310

使用教程

难度:入门 约 10 分钟 部署方式:云服务 7 步

⚠ 该项目 README 未提供完整安装说明,以下步骤为通用流程,请以官方文档为准。

环境要求

  • 一个已启用 GitHub Actions 的 GitHub 仓库
  • 用于所选模型服务商的 API Key,例如 OPENAI_API_KEY;使用 Azure 时则为 AZURE_OPENAI_API_KEY
  • 把 API Key 保存为 GitHub Actions Secret,不要把密钥写进工作流文件
  • 了解 GitHub Actions 工作流 YAML 的基本写法

安装与启动步骤

  1. 1启用仓库 Actions

    进入仓库 Settings 中的 Actions 页面,确认该仓库允许运行工作流,否则后续 workflow 不会触发。

  2. 2添加 API Key 密钥

    在 Settings → Secrets and variables → Actions 新建仓库 Secret,名称填 OPENAI_API_KEY,值为真实密钥。

  3. 3新建工作流文件

    在仓库 .github/workflows/ 下新建 YAML 文件,用 uses 引用 openai/codex-action,版本标签以仓库 Releases 为准。

  4. 4设置触发事件

    按 README 示例可用 pull_request 事件,即用户创建 PR 时自动运行;也可换成自己需要的事件。

  5. 5传入 prompt 参数

    在 with 中传入 prompt,内容包含该 PR 的具体信息,Codex 会据此执行任务。

  6. 6读取输出并回写

    示例流程会取 Codex 的输出,作为评论发布到对应 PR 上;再把工作流文件提交到仓库。

  7. 7查看运行日志

    在仓库 Actions 页面打开本次运行记录,查看 Codex 执行过程与输出,按需调整 prompt。

关键配置

配置项必填说明示例
OPENAI_API_KEY是模型服务商 API Key,需存为 GitHub Actions Secretsk-xxxxxxxxxxxxxxxxxxxx
AZURE_OPENAI_API_KEY否使用 Azure 提供 OpenAI 模型时改用的密钥xxxxxxxxxxxxxxxxxxxxxxxx
prompt是传给 Codex 的任务提示词,示例中包含 PR 的具体信息Review this pull request and summarize the changes.

如何确认成功

Actions 中该工作流运行状态为成功,日志里能看到 Codex 的输出,且 PR 下出现对应评论。

常见问题

Q:必须自己提供 API Key 吗?

A:是,README 明确要求用户把所选服务商的 API Key(如 OPENAI_API_KEY)配置为 GitHub Actions Secret 后才能使用该 Action。

Q:可以用 Azure 上的 OpenAI 模型吗?

A:可以,README 提到使用 Azure 提供 OpenAI 模型时,改为提供 AZURE_OPENAI_API_KEY,并按文档中的 Azure 章节配置。

Q:uses 后面的版本号怎么写?

A:README 节选未给出具体版本标签,请以仓库 Releases 或 Marketplace 页面列出的版本为准,不要随意填写不存在的标签。

Q:如何安全地使用这个 Action?

A:README 建议参考 docs/security.md,其中给出安全使用方式以及 Codex 权限控制的相关说明。

注意事项

  • 密钥只放在 Actions Secret 中,不要硬编码进工作流文件或提交到仓库。
  • 该 Action 会安装 Codex CLI 并通过安全的代理访问 Responses API,权限范围需按需收紧。
  • README 节选未包含完整的 workflow 示例,具体输入参数请以仓库中的 action.yml 与文档为准。

核心亮点

  • 以 GitHub Action 形式分发,接入只需在工作流中增加一个 step,无需自建服务
  • 能绑定 issue、PR、定时任务等事件触发,把 AI 编码嵌入现有协作流程
  • 自动产出分支或 PR 并回写日志,结果可审查、可回滚,符合代码评审习惯

不足之处

  • 强依赖外部模型服务与密钥配置,离线或受限环境不可用
  • 复杂仓库的上下文选取与多文件改动效果依赖提示词调优,稳定性待验证

适用场景

  • 收到 issue 后自动生成修复分支并提交 PR 供人工评审
  • 定时扫描仓库执行依赖升级、格式整理等重复性维护任务
  • 在 PR 流程中自动补充测试用例或更新文档

替代项目

aider、swe-agent、openhands

上一篇:objeck-lang

下一篇:com.openai.unity

同类项目推荐

plandex 开源

把大任务拆小,AI 一步步帮你改代码,搞定复杂项目。

Open source AI coding agent. Designed for large projects and real world tasks.

★ 15931 2026-08-09
crit 开源

给AI代理装个反馈闭环,让每次修改都更懂你

Review AI coding agents' plans, diffs and running apps in the browser. Local-first, ···

★ 1351 2026-08-09
parrot.nvim 开源

在 Neovim 里直接和大模型对话,写代码不打断思路。

parrot.nvim - the plugin that brings stochastic parrots to Neovim.

★ 792 2026-08-09
RAPx 开源

给 AI 写的 Rust 代码加一道静态检查护栏

A static analysis tool for Rust programs. The guardrail for AI-generated Rust code.

★ 232 2026-09-16
token-goat 开源

给 AI 编程工具装上 token 节流阀,省钱又专注

Auto AI improver. Cost and token burn reducer, turn saver, and focus keeper for Clau···

★ 148 2026-08-09
Brokies-AI-Foundry 开源

一份清单,帮你挑免费AI开发工具,省时省力

Top Free AI Developer Tools for 2026

★ 127 2026-08-09
dvalincode 开源

让 AI 编码在合规监管下安全落地,全程可审计

Independent security verification for code written by humans and AI agents. Scan, re···

★ 121 2026-08-09
LeanCopilot 开源

在 Lean 里写证明时,让 LLM 实时给下一步建议

LLMs as Copilots for Theorem Proving in Lean

★ 1348 2026-10-23
deepx-code 开源

终端里的 DeepSeek 编码助手,图谱+压缩双管齐下省 Token

deepseek标配coding agent、原生支持模型路由、CodeGraph代码图谱、OCR截图识别、自动上下···

★ 394 2026-09-29