For questions, check out the discussions.
For documentation, check out this document and the official documentation.
If you think Reviewpad is or could be useful for you, come say hi on Discord.
To start using Reviewpad, check out the Reviewpad GitHub Action.
Reviewpad is an open-source tool to automate pull request workflows.
The workflows are specified in a YML-based configuration language described in the official documentation.
In Reviewpad, you can automate actions over the pull requests such as:
- Automated comments;
- Add or remove labels;
- Specify reviewer assignments;
- Automate close/merge actions.
As an example, the following workflow:
api-version: reviewpad.com/v2.x
labels:
ship:
description: Ship mode
color: 76dbbe
rules:
- name: changesToMDFiles
kind: patch
description: Patch only contains changes to files with extension .md
spec: $hasFileExtensions([".md"])
workflow:
- name: ship
description: Ship process - bypass the review and merge with rebase
if:
- rule: changesToMDFiles
then:
- $addLabel("ship")
- $merge()Automatically adds a label ship and merges pull requests that only change .md files.
You can execute Reviewpad through the CLI or through the Reviewpad GitHub action.
This repository generates two artifacts:
- CLI cmd/cli that runs reviewpad open source edition.
- Reviewpad library packages:
├ github.com/reviewpad/reviewpad/collector
├ github.com/reviewpad/reviewpad/engine
├ github.com/reviewpad/reviewpad/lang/aladino
├ github.com/reviewpad/reviewpad/plugins/aladino
├ github.com/reviewpad/reviewpad/utils/fmtio
Conceptually, the packages are divided into four categories:
- Engine: The engine is the package responsible of processing the YML file. This process is divided into two stages:
- Process the YML file to determine which workflows are enabled. The outcome of this phase is a program with the actions that will be executed over the pull request.
- Execution of the synthesised program.
- Aladino Language: This is the language that is used in the
specproperty of the rules and also the actions of the workflows. The engine of Reviewpad is not specific to Aladino - this means that it is possible to add the support for a new language such asJavascriptorGolangin these specifications. - Plugins: The plugin package contains the built-in functions and actions that act as an abstraction to the 3rd party services such as GitHub, Jira, etc. This package is specific to each supported specification language. In the case of
plugins/aladino, it contains the implementations of the built-ins of the team edition. - Utilities: packages such as the collector and the fmtio that provide utilities that are used in multiple places.
This project uses the Goyacc, a version of yacc for Go, used to create the Aladino parser, to install goyacc run:
go install golang.org/x/tools/cmd/goyacc@masterWe use Taskfile. To compile the packages simply run:
task buildTo generate the CLI of the team edition run:
task build-cmdThis command generate the Reviewpad CLI main which you can run to try Reviewpad directly. The CLI has the following argument list:
./main --help
Usage of ./main:
-dry-run bool
Dry run mode
-event-payload string (optional)
File path to github action event in JSON format
-github-token string
GitHub token
-mixpanel-token string (optional)
Mixpanel token
-pull-request string
Pull request GitHub url
-reviewpad string
File path to reviewpad.ymlWe strongly recommend the use of VSCode but feel free to use the IDE of your choice. For the case of VSCode we also recommend the installation of the following extensions:
- EditorConfig - To helps maintaining consistent coding styles.
- licenser - For adding license headers.
- YAML - For enabling
reviewpad.ymlJSON schema.
On your VSCode settings please add the following settings:
{
// Format files on save
"editor.formatOnSave": true,
// Licenser configuration
"licenser.license": "Custom",
"licenser.author": "Explore.dev, Unipessoal Lda",
"licenser.customHeader": "Copyright (C) @YEAR@ @AUTHOR@ - All Rights Reserved\nUse of this source code is governed by a license that can be\nfound in the LICENSE file.",
// reviewpad.yml JSON schema
"yaml.schemas": {
"https://raw.githubusercontent.com/reviewpad/schemas/main/latest/schema.json": [
"reviewpad.yml",
]
},
// File nesting
"explorer.fileNesting.patterns": {
// Next go and go test files
"*.go": "${capture}_test.go",
},
}Add the following to your .vscode/launch.json.
{
"version": "0.2.0",
"configurations": [
{
"name": "Launch CLI",
"type": "go",
"request": "launch",
"mode": "debug",
"args": [
// Flag to run on dry run
"-dry-run",
// Absolute path to reviewpad.yml file to run
"-reviewpad=_PATH_TO_REVIEWPAD_FILE_",
// GitHub url to run the reviewpad.yml against to
// e.g. https://github.com/reviewpad/action-demo/pull/1
"-pull-request=_PULL_REQUEST_URL_",
// GiHub personal access token
// https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
"-github-token=_GIT_HUB_TOKEN_",
// Absolute path to JSON file with GitHub event payload
"-event-payload=_PATH_TO_EVENT_JSON",
],
"program": "${workspaceFolder}/cmd/cli/main.go"
}
]
}We welcome contributions to Reviewpad from the community!
See the Contributing Guide.
If you need any assistance, please join discord to reach the core contributors.
Take a look at the X-Ray for Reviewpad to see how we are doing!
Reviewpad is available under the GNU Lesser General Public License v3.0 license.
See LICENSE for the full license text.