website·Indexed 33 days ago
https://docs.reviewpad.com/Documentation for Reviewpad, a GitHub App designed to automate pull request workflows. It includes guides on the Aladino language for workflow specification, built-in functions like addAssignees and addLabel, merge protection via Reviewpad Protect, and AI-powered summarization using Reviewpad AI. The docs cover installation, configuration syntax, and tools like Reviewpad Check for identifying pull requests that require attention.
reviewpad.yml configuration file. This file must be located at the root of each repository where Reviewpad is enabled; otherwise, the app will not take any action.Workflows automate actions on GitHub entities. A workflow is defined by the following fields:
name: (Required) A unique string identifier for the workflow.description: (Optional) A string providing more details about the workflow.on: (Optional) A list of GitHub entity types that trigger the workflow. Defaults to pull_request.trigger-on-check: (Optional) The unique ID of a check. The workflow only triggers when an issue is identified by that check.run: (Required) The action or list of actions to execute.non-conventional-commits check identifies pull requests that contain commit messages not complying with the Conventional Commits specification. Using this check ensures consistency in commit history, simplifies code reviews, and enables automated tools to generate release notes, changelogs, and version bumps.$reportInfo, $reportWarn, and $reportError within a Reviewpad configuration file.git-conflict check (v4) automatically identifies pull requests that have git conflicts between the head and base branches. This allows developers to resolve inconsistencies and integrity issues early in the PR lifecycle to avoid deployment delays.checks:
git-conflict:
label: git-conflict
activation: onreportWarning built-in function (v4) allows you to add a specific warning message to the warnings section of a Reviewpad report. This is typically used within a workflow's then block to alert developers about specific issues found during validation.workflows:
- name: validate-changes
run:
if: $containsFilePattern("*.lock")
then: $reportWarning("Please remove the lock file from the commit.")Aladino supports five value types: booleans, numbers, strings, arrays, and _action_. To ensure a workflow is valid, you must adhere to two primary typing requirements:
spec field in a rule must evaluate to a bool. Providing a string or other type will result in a type error.then block (action) in a workflow must evaluate to the _effect_ type. Providing a simple string will result in a type error.# INVALID: spec must be bool, not string
- name: doesnt-type-check-to-bool
kind: patch
description: Rule that does not type check to bool
spec: "hello" # type error
# INVALID: action must be _effect_, not string
- name: invalid-workflow
description: Invalid workflow because of action
run:
if: rule_1
then: "hello" # type errorTo avoid parse errors in Reviewpad configurations, adhere to the following syntax rules:
") instead of single quotes (').$).(), even if they take no arguments.# Correct Examples
$addLabel("hello") # Use double quotes
$containsFileName("README.md") # Use $ prefix
$isMerged() # Use parenthesesReviewpad supports loops using the forEach structure to iterate over defined groups or dictionaries.
in: Reference to the group (via $group("name")) or dictionary (via $dictionary("name")).value: An Aladino identifier to access the current element's value.key: An Aladino identifier to access the current key (used only for dictionaries).do: The action or list of actions to execute for each element.# Example: Loop over a dictionary to assign teams based on file paths
dictionaries:
- name: approval-team-per-file-path
spec:
'**/authentication/**': '"security"'
'**/db/**': '"dba"'
workflows:
- name: assign-by-path
run:
- forEach:
key: $filePattern
value: $teamName
in: $dictionary("approval-team-per-file-path")
do:
- if: $containsFilePattern($filePattern)
then: $addTeamsForReview([$teamName])