katalyst-api/.coderabbit.yaml at main · kubewharf/katalyst-api · 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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
language: "en-US"
early_access: false
tone_instructions: >-
  Prioritize correctness, API compatibility, nil/error handling, and tests.
  Write concise English text first, then equivalent Simplified Chinese. Do not
  translate code, paths, APIs, markers, protobuf names, or error strings.

reviews:
  profile: "chill"
  request_changes_workflow: false
  high_level_summary: true
  high_level_summary_instructions: >-
    Summarize API surface changes, compatibility impact, code generation impact,
    and expected downstream consumer updates. Call out when changes are docs-
    only or generated-only. Write concise English text first, then equivalent
    Simplified Chinese. Do not translate code, paths, APIs, markers, protobuf
    names, or error strings.
  high_level_summary_in_walkthrough: false
  review_status: true
  collapse_walkthrough: true
  poem: false
  slop_detection:
    enabled: true
  auto_review:
    enabled: true
    drafts: false
    auto_pause_after_reviewed_commits: 0
    base_branches:
      - "main"
    ignore_title_keywords:
      - "WIP"
      - "DRAFT"
      - "DO NOT MERGE"
  path_filters:
    - "!**/*.pb.go"
    - "!**/zz_generated_*.go"
    - "!pkg/client/**"
    - "!config/crd/bases/**"
    - "!docs/imgs/**"
    - "!**/*.png"
    - "!**/*.jpg"
    - "!**/*.jpeg"
    - "!**/*.gif"
    - "!**/*.svg"
  path_instructions:
    - path: "go.mod"
      instructions: |
        Review dependency and toolchain changes for API compatibility, generator drift, and downstream consumer impact.
        Flag version bumps that likely require coordinated changes in katalyst-core or regeneration steps.
    - path: ".github/workflows/**"
      instructions: |
        Review CI and automation changes for correct branch triggers, pinned actions where appropriate, timeout and permission hygiene, and consistency with this repo's validation flow.
        Flag changes that bypass fmt, inlinecheck, generation, or other expected API validation steps.
    - path: "pkg/apis/**"
      instructions: |
        Review for backward-compatible API evolution only.
        Flag removed or renamed exported fields, json tag changes, new required behavior in existing versions, incorrect kubebuilder markers, and inline anonymous structs.
    - path: "pkg/protocol/**/*.proto"
      instructions: |
        Review for append-only protobuf compatibility.
        Flag reused field numbers, wire-incompatible changes, required fields, and protocol changes without corresponding compatibility notes or tests.
    - path: "pkg/consts/**"
      instructions: |
        Check that constants remain canonical and compatibility-safe for downstream consumers.
        Flag duplicate keys, silent semantic changes, and changes that should be documented as cross-repo impacts.
    - path: "**/*_test.go"
      instructions: |
        Prefer focused tests that cover serialization, deepcopy, protocol, and compatibility-sensitive edge cases when relevant.
        Avoid asking for broad speculative tests that mostly restate the implementation.
    - path: "docs/**/*.md"
      instructions: |
        Check for technical accuracy, outdated API behavior, and missing notes about compatibility, generation, or downstream impact.

knowledge_base:
  automatic_repository_linking: true

chat:
  auto_reply: true