reviewpad.yml

# Define the list of rules to be used by Reviewpad.
rules:
  - name: is-release-branch
    spec: $base() == "release/beta" || $base() == "release/stable" || $base() == "release/next"
  - name: is-main-branch
    spec: $base() == "main"

# Define the list of workflows to be run by Reviewpad.
# A workflow is a list of actions that will be executed based on the defined rules.
# For more details see https://docs.reviewpad.com/guides/syntax#workflow.
workflows:
  # This workflow praises contributors on their pull request contributions.
  # This helps contributors feel appreciated.
  - name: praise-contributors-on-milestones
    description: Praise contributors based on their contributions
    always-run: true
    if:
      # Praise contributors on their first pull request.
      - rule: $pullRequestCountBy($author()) == 1
        extra-actions:
          - $commentOnce($sprintf("Thank you @%s for this first contribution!", [$author()]))

  # This workflow validates that pull requests follow the conventional commits specification.
  # This helps developers automatically generate changelogs.
  # For more details, see https://www.conventionalcommits.org/en/v1.0.0/.
  - name: check-conventional-commits
    description: Validate that pull requests follow the conventional commits
    always-run: true
    if:
      - rule: $isDraft() == false
    then:
      # Check commits messages against the conventional commits specification
      - $commitLint()

  - name: check-conventional-commits-title
    description: Pull request titles to follow conventional commits when squashing and merging
    always-run: true
    run:
      if:
        - rule: $isDraft() == false && $rule("is-main-branch")
      then:
        - $titleLint()

  - name: license-validation
    description: Validate that licenses are not modified
    always-run: true
    if:
      # Fail Reviewpad check on pull requests that modify any LICENSE;
      - rule: $hasFilePattern("**/LICENSE*")
        extra-actions:
          - $fail("License files cannot be modified")

  - name: auto-merge-release-pr
    description: Automatically merge with a merge commit on release branch
    run:
      if:
        - rule: $rule("is-release-branch") && $approvalsCount() >= 1 && $haveAllChecksRunCompleted([], "success")
      then:
        - $merge("merge")