kueue/.coderabbit.yaml at main · CrazyForks/kueue · 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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
language: en-US

knowledge_base:
  code_guidelines:
    enabled: true
    filePatterns:
      - "AGENTS.md"

reviews:
  request_changes_workflow: false

  path_filters:
    - "!client-go/**"
    - "!**/*_generated*.go"
    - "!**/zz_generated.*.go"
    - "!**/openapi_generated.go"
    - "!vendor/**"

  path_instructions:
    - path: "apis/**/*.go"
      instructions: |
        Focus on Kubernetes CRD API conventions, kubebuilder validation markers,
        and backwards compatibility. Ensure optional fields use pointer types
        and carry `+optional` markers with clear godoc comments. Flag any
        breaking changes (field removal, renames, type changes) and verify
        CEL validation rules (`+kubebuilder:validation:XValidation`) are
        preferred over webhook-only validation.

    - path: "pkg/controller/**/*.go"
      instructions: |
        Review reconciliation logic for correctness, idempotency, and proper
        error handling. Ensure status updates use the status subresource.
        Verify that new controller behavior has corresponding unit and
        integration tests.

    - path: "pkg/webhooks/**/*.go"
      instructions: |
        Check that validating webhooks reject invalid input with clear error
        messages and that mutating webhooks set safe defaults. Ensure webhook
        changes are reflected in `config/components/webhook/`.

    - path: "pkg/constants/**/*.go"
      instructions: |
        Ensure no duplicate annotation, label, or environment variable keys.
        Verify new constants follow the existing naming conventions.

    - path: "pkg/scheduler/**/*.go"
      instructions: |
        Review scheduling logic for correctness and performance. Verify
        proper handling of resource flavors, cohort borrowing, and
        preemption policies.

    - path: "test/integration/**/*.go"
      instructions: |
        Verify tests use envtest and follow the existing table-driven test
        patterns with Ginkgo/Gomega. Ensure new test cases cover both
        positive and negative scenarios.

    - path: "test/e2e/**/*.go"
      instructions: |
        Verify E2E tests are self-contained and clean up resources. Tests
        should use Ginkgo/Gomega and follow the existing patterns in the
        suite.

    - path: "charts/**"
      instructions: |
        Verify Helm template correctness and that values.yaml defaults are
        consistent with the kustomize manifests in `config/`.

    - path: "site/**/*.md"
      instructions: |
        Focus on technical accuracy, clarity, and markdown formatting. Verify
        that code snippets and configuration examples match current CRD
        definitions.

    - path: "**/*_test.go"
      instructions: |
        Ensure tests follow the existing Ginkgo/Gomega patterns in the
        project. Prefer table-driven tests for multiple scenarios.

  auto_review:
    enabled: true
    ignore_title_keywords:
      - "WIP"
      - "DO NOT MERGE"
    drafts: false
    base_branches:
      - "main"
    labels:
      - "!needs-ok-to-test"
      - "!do-not-merge/work-in-progress"
      - "!cncf-cla: no"