reviewpad.yml

api-version: reviewpad.com/v3.x

labels:
  small:
    description: Pull request is small
    color: "#76dbbe"
  medium:
    description: Pull request is medium
    color: "#2986cc"
  large:
    description: Pull request is large
    color: "#c90076"
  dependencies:
    description: Something about our dependencies
    color: "#ff8722"
  build:
    description: Marks issues or pull requests regarding changes to the build tool
    color: "#FCEA0F"
  breaking-change:
    description: Marks a pull request as introducing breaking changes
    color: "#b3c9c9"
  no-releasenotes:
    description: To not include a pull request in the changelog
    color: "#333635"
  needs-review:
    description: Marks a pull request as waiting for review
    color: "#aa2297"

rules:
  - name: docs-changes
    spec: $hasFileExtensions([".md", ".txt"]) || $matchString("^docs(\([A-Za-z0-9_\/]+\))??:.+$", $title())
  - name: ci-changes
    spec: $hasFilePattern(".github/**") || $hasFilePattern(".circleci/**") || $hasFileName(".golangci.yml") || $hasFileName("reviewpad.yml") || $hasFileName(".goreleaser.yml") || $matchString("^ci(\([A-Za-z0-9_\/]+\))??:.+$", $title())
  - name: deps-changes
    spec: $hasFileName("go.mod") || $hasFileName("go.sum") || $matchString("^build\(deps\)\/.+", $title())
  - name: feat-changes
    spec: $matchString("^feat(\([A-Za-z0-9_\/]+\))??:.+$", $title())
  - name: fix-changes
    spec: $matchString("^fix(\([A-Za-z0-9_\/]+\))??:.+$", $title())
  - name: breaking-changes
    spec: $matchString("^([A-Za-z0-9_]+)??(\([A-Za-z0-9_\/]+\))??!:.+$", $title())
  - name: exclude-changes
    spec: $matchString("^(chore|refactor|revert|perf|test)(\([A-Za-z0-9_\/]+\))??:.+$", $title())
  - name: build-changes
    spec: $hasFileName("makefile") || $matchString("^build(\([A-Za-z0-9_\/]+\))??:.+$", $title())

groups:
  - name: ignore-patterns
    spec: '["go.sum"]'

workflows:
  - name: praise-contributors
    description: Praise contributors
    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()]))
      # Praise contributors on their 10th pull request.
      - rule: $pullRequestCountBy($author()) == 10
        extra-actions:
          - $commentOnce($sprintf("Way to go %s 🎉 ... This is your 10th pull request!", [$author()]))

  - 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()
      # Check pull request title against the conventional commits specification.
      - $titleLint()

  - name: best-practices
    description: Validate best practices for pull request management
    always-run: true
    if:
      # Warn pull requests that do not have an associated GitHub issue.
      - rule: $hasLinkedIssues() == false
        extra-actions:
          - $warn("Please link an issue to the pull request")
      # Warn pull requests if their description is empty.
      - rule: $description() == ""
        extra-actions:
          - $warn("Please provide a description for the pull request")
      # Warn pull request do not have a clean linear history.
      - rule: $hasLinearHistory() == false
        extra-actions:
          - $warn("Please rebase your pull request on the latest changes")

  - name: size-labeling
    description: Label pull request based on the number of lines changed
    always-run: true
    if:
      - rule: $size($group("ignore-patterns")) < 100
        extra-actions:
          - $removeLabels(["medium", "large"])
          - $addLabel("small")
      - rule: $size($group("ignore-patterns")) >= 100 && $size() < 300
        extra-actions:
          - $removeLabels(["small", "large"])
          - $addLabel("medium")
      - rule: $size($group("ignore-patterns")) >= 300
        extra-actions:
          - $removeLabels(["small", "medium"])
          - $addLabel("large")

  - name: pulls-labelling
    description: Label pull requests
    always-run: true
    if:
      - rule: docs-changes
        extra-actions:
          - $addLabel("docs")
      - rule: ci-changes
        extra-actions:
          - $addLabel("ci")
      - rule: deps-changes
        extra-actions:
          - $addLabel("dependencies")
      - rule: build-changes
        extra-actions:
          - $addLabel("build")
      - rule: feat-changes
        extra-actions:
          - $addLabel("enhancement")
      - rule: fix-changes
        extra-actions:
          - $addLabel("bug")
      - rule: breaking-changes
        extra-actions:
          - $addLabel("breaking-change")
      - rule: exclude-changes
        extra-actions:
          - $addLabel("no-releasenotes")
      - rule: $isWaitingForReview()
        extra-actions:
          - $addLabel("needs-review")
      - rule: $isWaitingForReview() == false
        extra-actions:
          - $removeLabel("needs-review")