floci/.coderabbit.yaml at main · floci-io/floci · 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
reviews:
  poem: false
  sequence_diagrams: true
  auto_review:
    drafts: false
    base_branches:
      - main
  path_filters:
    - "!**/target/**"
    - "!**/*.lock"
    - "!compatibility-tests/sdk-test-*/target/**"
  path_instructions:
    - path: "docs/services/*.md"
      instructions: |
        Verify the operation count listed for this service matches the row in
        docs/services/index.md. Counts come from controller dispatch handlers
        (not @Path annotation totals), so one @Path can serve multiple AWS
        operations via query-string or header markers. If a new operation is
        added to the table, check the corresponding Java handler exists in
        src/main/java/io/github/hectorvent/floci/services/.
    - path: "src/main/java/io/github/hectorvent/floci/services/**/*Controller.java"
      instructions: |
        When adding a new @Path handler or AWS operation branch:
        1. Check that the corresponding docs/services/{service}.md Supported
           Operations table and the row in docs/services/index.md are updated
           in the same PR. The repo has a history of doc drift; flag any new
           operation that lacks a docs update.
        2. Verify error responses map to the correct AWS error code, HTTP
           status, and wire format (XML for S3/SQS/SNS/IAM, JSON for most
           others). Real AWS clients parse these strictly.
        3. Flag any shared mutable state (static fields, singleton beans,
           in-memory stores) that is not thread-safe. Prefer ConcurrentHashMap
           or explicit synchronization.
    - path: "CHANGELOG.md"
      instructions: |
        Generated/maintained via semantic-release. Skip review of formatting
        and content; only flag entries that reference non-existent commits or
        issue numbers.
    - path: "compatibility-tests/sdk-test-*/**/*Test.java"
      instructions: |
        Prefer reusing fixtures from TestFixtures.java over duplicating setup
        inline. Flag hard-coded credentials, region strings, or endpoint URLs
        that should live in shared helpers.
    - path: "pom.xml"
      instructions: |
        Review dependency changes for version conflicts, transitive upgrades,
        and license compatibility. Flag new dependencies without clear
        justification. Ensure the Quarkus BOM drives version alignment for
        Quarkus extensions rather than pinning individual versions.
    - path: "**/Dockerfile*"
      instructions: |
        Prefer multi-stage builds, pinned base image tags (never :latest),
        and minimal final layers. Flag any RUN steps that could be combined
        or that leave package manager caches in the image.
    - path: "**/*.sh"
      instructions: |
        Flag unquoted variable expansions, missing `set -euo pipefail`, and
        portability issues. shellcheck runs automatically but add context on
        intent where a warning is intentionally suppressed.