github-actions-shared-workflows/.coderabbit.yml at main · LerianStudio/github-actions-shared-workflows · 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
language: "en-US"

tone_instructions: >
  Be direct and technical. Focus on correctness, security, and maintainability.
  Flag breaking changes to callers explicitly. Skip praise for routine changes.

early_access: false

reviews:
  profile: "assertive"

  high_level_summary: true
  high_level_summary_in_walkthrough: false

  review_status: true
  review_details: false
  collapse_walkthrough: false
  changed_files_summary: true
  sequence_diagrams: false

  poem: false

  suggested_labels: true
  auto_apply_labels: false

  suggested_reviewers: true
  auto_assign_reviewers: false

  request_changes_workflow: true

  abort_on_close: true

  path_filters:
    - "!CHANGELOG.md"
    - "!.releaserc.yml"

  path_instructions:
    - path: ".github/workflows/self-*.yml"
      instructions: |
        This is a self-use entrypoint for this repository — NOT a reusable workflow.
        Do NOT flag missing `workflow_call` — these files intentionally omit it.
        `dry_run` is not required; flag it only if it is marked `required: true` or lacks a default value.
        When `dry_run` is present it must be: type boolean, required false, default true for destructive operations (delete, purge) or default false for non-destructive ones (sync, notify).
        Must call the corresponding reusable workflow via local path and contain no business logic.

    - path: ".github/workflows/*.yml"
      instructions: |
        This is a reusable workflow in a shared CI/CD library. Repo-specific rules:
        - Both `workflow_call` and `workflow_dispatch` must be present (except self-* files)
        - Workflows that apply state changes must have a `dry_run` boolean input (default: false)
        - Composites must use local path only: `./src/<capability>/<name>` — never an external ref
        - A `docs/<filename>.md` matching this workflow's name must exist or be added in this PR
        - Flag any removed or renamed input/output as a breaking change for callers

    - path: "src/**/action.yml"
      instructions: |
        This is a composite action in a shared CI/CD library. Repo-specific rules:
        - Max 15 steps — flag if exceeded
        - Single responsibility only — no multi-language runtimes, no job definitions
        - Flag any removed, renamed, or retyped input/output as a breaking change for callers
        - Flag any default value change as a potentially breaking change

    - path: "src/**/README.md"
      instructions: |
        Composite action README. Verify inputs table matches `action.yml` exactly (name, required, default).
        Flag any usage example that references `@main` — examples must use `@develop` or `@feat/<branch>` for testing and `@vX.Y.Z` for production.

    - path: "docs/*.md"
      instructions: |
        Workflow documentation. Filename must exactly match the workflow file (e.g., `go-ci.yml` → `docs/go-ci.md`).
        Flag if inputs table is out of sync with the corresponding workflow changes in this PR.
        Flag any usage example that references `@main` — examples must use `@develop` or `@feat/<branch>` for testing and `@vX.Y.Z` for production.

  auto_review:
    enabled: true
    drafts: false
    base_branches:
      - "develop"
    ignore_title_keywords:
      - "WIP"
      - "wip"
      - "[skip review]"
    auto_pause_after_reviewed_commits: 0

chat:
  auto_reply: true