Skip to content
Merged
6 changes: 6 additions & 0 deletions .refix.yaml.sample
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ models:

ci_log_max_lines: 120

# Whether to enable execution reports written by Claude (Optional)
# When enabled, runtime reports are embedded into the PR state comment
# and Claude receives instructions to append report entries to a report file.
# Default: false
execution_report: false

# Automatically merge PR when it reaches refix:done state (Optional)
# When merge completes, refix:merged label is added.
# Default: false
Expand Down
12 changes: 12 additions & 0 deletions README.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,8 @@ models:

ci_log_max_lines: 120

execution_report: false

auto_merge: false

coderabbit_auto_resume: false
Expand Down Expand Up @@ -141,6 +143,16 @@ Claude ベースの処理で使うモデル設定です。

PR に失敗中の GitHub Actions がある場合、この値でプロンプトへ渡すログ量を調整できます。値を小さくするとプロンプトは軽くなり、大きくすると文脈を多く渡せます。

#### `execution_report`

Claude の実行レポート機能を有効にするかどうかを設定します。

- 型: boolean
- 必須: いいえ
- デフォルト: `false`

有効にすると、`refix` は各修正フェーズで Claude に構造化された実行レポートの追記を指示し、その内容を CI ログでは折りたたみ表示しつつ、PR の状態管理コメントの `実行レポート` セクションにも記録します。

#### `auto_merge`

PR が `refix:done` 状態になった際に自動マージします。
Expand Down
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,9 @@ models:

ci_log_max_lines: 120

# Whether to record Claude execution reports (optional, default false)
execution_report: false

# Automatically merge PR when it reaches refix:done state (optional, default false)
# When merge completes, the refix:merged label is applied
auto_merge: false
Expand Down Expand Up @@ -153,6 +156,16 @@ Maximum number of failed CI log lines included in the fix prompt.

Use this to control prompt size when a PR has failing GitHub Actions checks. Smaller values reduce prompt volume, while larger values include more context from failed jobs.

#### `execution_report`

Whether to enable Claude execution reports.

- Type: boolean
- Required: no
- Default: `false`

When enabled, `refix` asks Claude to append structured runtime notes to a report file during each fix phase, prints that report in foldable CI log groups, and embeds the collected report into the PR state comment under `実行レポート`.

#### `auto_merge`

Automatically merge the fix PR when it reaches the `refix:done` state.
Expand Down
Loading
Loading