identity-apps/.coderabbit.yml at master · Lakshan-Banneheke/identity-apps · 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
language: en-US
tone_instructions: ""
early_access: false
enable_free_tier: true
reviews:
  profile: chill
  request_changes_workflow: false
  high_level_summary: false
  sequence_diagrams: false
  estimate_code_review_effort: false
  auto_assign_reviewers: true
  poem: false
  auto_review:
    ignore_usernames: ["wso2-jenkins-bot"]
    base_branches:
      - "next"
      - "master"
  pre_merge_checks:
      custom_checks:
        - name: "Changeset Required"
          mode: error
          instructions: |
            Check if the CHANGED FILE LIST IN THE PULL REQUEST includes at least one changeset file.

            IMPORTANT: DO NOT consider the existing md files that are NOT part of the changed file list in the pull request being reviewed. ALWAYS consider ONLY the changed files in the pull request.

            A changeset file is any file matching the pattern `.changeset/*.md` (excluding `.changeset/README.md`). It should contain all the changed packages in the pull request along with the version update type.

            For the updates to "features", "modules" directories, make sure to also include `@wso2is/console`, `@wso2is/myaccount` or `@wso2is/identity-apps-core` in
            the changeset with a proper version update accordingly. If there are new packages in the pull request, those new packages should be mentioned as a major version update in the changeset.

            EXCEPTION: Changesets are NOT required if the pull request ONLY modifies files in the following locations:
              - `README` files
              - `docs/`
              - `scripts/`
              - `.github/`
              - configuration files located in the project root

            If ALL changed files fall exclusively into the above categories, the check should PASS even if no changeset file is present.

            **Pass Criteria:**
            - At least one NEW `.md` file exists in the `.changeset/` directory in the CHANGED FILE LIST of the pull request.
            - The file should NOT be `.changeset/README.md`

            **Fail Criteria:**
            - No changeset files are present in the CHANGED FILE LIST of the pull request.
            - Only `.changeset/README.md` is modified

            If no changeset is found, the check should fail with a clear explanation that changesets are required for tracking changes.
  path_instructions:
    - path: ".changeset/**-**-**.md"
      instructions: |
        Check if this changeset file contains a `minor` or `major` version bump for any package.

        Version bumps are declared in the frontmatter between `---` delimiters, in the format:
        ```
        "@package/name": minor
        "@package/name": major
        "@package/name": patch
        ```

        If any package in this changeset is declared with a `minor` or `major` bump, post a review comment with the following message:
        "⚠️ **Version Bump Warning:** This changeset contains a `minor` or `major` version bump. Please downgrade it to a `patch` bump. We are currently in the **IS 7.3 release cycle** and the **alpha version has already been released**, so introducing `minor` or `major` version bumps at this stage would interrupt the release workflows and is not permitted until the release is complete."
knowledge_base:
  code_guidelines:
    enabled: true
    filePatterns: ["docs/write-code/CODE_QUALITY.md"]