codez/action.yml at main · YiweiShen/codez · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
name: 'Codez Action'
description: 'Codex in GitHub Actions'
author: 'yiweishen'
branding:
  icon: 'code'
  color: 'purple'

inputs:
  github-token:
    description: 'Specify the GitHub Token'
    required: true
  event-path:
    description: 'Specify the path to the GitHub Event JSON file'
    default: ${{ github.event_path }}
    required: false
  timeout:
    description: 'Specify timeout duration in seconds (must be a positive integer)'
    default: '600'
    required: false
  openai-api-key:
    description: 'Specify the OpenAI API Key'
    required: true
  openai-base-url:
    description: 'Specify the OpenAI API base URL'
    required: false
  openai-model:
    description: 'OpenAI model identifier to use (default: gpt-5.3-codex)'
    required: false
  openai-commit-message-model:
    description: 'OpenAI model identifier used to generate commit messages (default: gpt-4.1-mini)'
    required: false
  direct-prompt:
    description: 'One-shot prompt for automated workflows. Bypasses comment triggers.'
    required: false
  trigger-phrase:
    description: 'Custom trigger phrase to invoke Codez (default: /codex)'
    required: false
    default: '/codex'
  assignee-trigger:
    description: 'Comma-separated list of GitHub usernames. Codez will run when an issue is assigned to these users.'
    required: false
    default: ''
  codex-env:
    description: |
      Custom environment variables to inject into the Codex CLI execution context.
      Accepts either a YAML mapping (multiline) or comma-separated key=value pairs.
    required: false
    default: ''
  images:
    description: |
      Comma-separated or newline-separated list of local image file paths to include in the Codex CLI invocation.
      Each image can be referenced in the prompt by `<image_0>`, `<image_1>`, etc.
    required: false
    default: ''
  fetch:
    description: 'Fetch known URLs referenced in the prompt and include their contents in the prompt'
    required: false
    default: 'false'

runs:
  using: 'docker'
  image: 'docker://ghcr.io/yiweishen/codez:latest'