Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .refix.yaml.sample
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ ci_log_max_lines: 120
# Default: false
auto_merge: false

# Automatically post `@coderabbitai resume` after a CodeRabbit rate-limit wait expires (Optional)
# Default: false
coderabbit_auto_resume: false

# Whether to process DRAFT PRs (Optional)
# Default: false (skip DRAFT PRs)
process_draft_prs: false
Expand Down
25 changes: 25 additions & 0 deletions README.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
- 修正後にレビュー スレッドを解決する
- PR 上の状態管理コメントと `refix:running` / `refix:done` ラベルで進捗を記録する

CodeRabbit がレビュー側のレートリミットに到達した場合でも、`refix` は PR を `refix:running` のまま維持し、CI 修正とベースブランチ追従だけを進め、レビュー修正と auto-merge は再開可能になるまで保留します。

## 主な機能

### レビュー要約
Expand Down Expand Up @@ -89,6 +91,12 @@ models:

ci_log_max_lines: 120

auto_merge: false

coderabbit_auto_resume: false

process_draft_prs: false

repositories:
- repo: "owner/repo"
user_name: "Refix Bot"
Expand Down Expand Up @@ -149,6 +157,16 @@ PR が `refix:done` 状態になった際に自動マージします。

`false`(デフォルト)の場合、ドラフト PR はスキップされます。`true` にすると、通常のオープン PR と同様にドラフト PR も処理されます。

#### `coderabbit_auto_resume`

CodeRabbit のレートリミットコメントに記載された待機時間が経過したあと、自動で `@coderabbitai resume` コメントを投稿するかどうかを設定します。

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

レートリミット中は、`refix` は PR を `refix:running` に保ち、レビュー修正と auto-merge を止めつつ、CI 修正とベースブランチ取り込みは継続します。この設定を `true` にすると、待機時間経過後に自動で CodeRabbit の再開を促します。

#### `repositories`

`refix` が処理する対象リポジトリの一覧です。
Expand Down Expand Up @@ -198,6 +216,7 @@ PR が `refix:done` 状態になった際に自動マージします。
- 未知のキーは即エラーではなく、警告を出して無視されます。
- `models.summarize` で要約処理で使用するモデルを指定します。この設定は環境変数 `REFIX_MODEL_SUMMARIZE` より優先されます。
- `models.fix` で修正処理で使用するモデルを指定します。
- `coderabbit_auto_resume` は、最新の CodeRabbit レートリミット通知より後にすでに `@coderabbitai resume` コメントがある場合は重複投稿しません。

## GitHub Actions での実行方法

Expand Down Expand Up @@ -248,6 +267,12 @@ models:

ci_log_max_lines: 120

auto_merge: false

coderabbit_auto_resume: false

process_draft_prs: false

repositories:
- repo: "your-org/your-repo"
user_name: "Refix Bot"
Expand Down
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ For each configured repository, `refix` can:
- resolve review threads after successful fixes, and
- persist progress in a PR state comment and with labels such as `refix:running` and `refix:done`.

When CodeRabbit reports a review-side rate limit, `refix` keeps the PR in `refix:running`, still allows CI repair and base-branch catch-up, and skips review-fix / auto-merge until CodeRabbit can resume.

## Features

### Review summarization
Expand Down Expand Up @@ -92,6 +94,10 @@ ci_log_max_lines: 120
# Automatically merge PR when it reaches refix:done state (optional, default false)
auto_merge: false

# Automatically post `@coderabbitai resume` after a CodeRabbit rate-limit wait expires
# (optional, default false)
coderabbit_auto_resume: false

# Whether to process draft PRs (optional)
# Default: false (draft PRs are skipped)
process_draft_prs: false
Expand Down Expand Up @@ -157,6 +163,16 @@ Whether to include draft PRs in the processing targets.

When set to `false` (the default), draft PRs are skipped. Set to `true` to process draft PRs alongside regular open PRs.

#### `coderabbit_auto_resume`

Whether `refix` should automatically post `@coderabbitai resume` after a CodeRabbit rate-limit comment says the wait time has elapsed.

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

When a rate-limit notice is active, `refix` keeps the PR in `refix:running`, skips review-fix / auto-merge, and still performs CI repair plus base-branch merge handling. Enabling this option lets `refix` resume CodeRabbit automatically once the wait window has passed.

#### `repositories`

List of repositories that `refix` should process.
Expand Down Expand Up @@ -205,6 +221,7 @@ If omitted, `refix` falls back to the effective Git identity available in the ex
- `repositories` must be present and must contain at least one entry.
- Unknown keys are ignored with warnings rather than treated as hard errors.
- `models.summarize` in YAML takes priority over the `REFIX_MODEL_SUMMARIZE` environment variable when selecting the summarization model.
- The `coderabbit_auto_resume` option only affects active CodeRabbit rate-limit comments; duplicate `@coderabbitai resume` comments are avoided when one has already been posted after the latest rate-limit notice.

## Running in CI with GitHub Actions

Expand Down
Loading
Loading