This project is now in maintenance mode. Please feel free to fork the project to apply any changes you might want to make.

Reviewpad

Welcome to Reviewpad!

For questions, check out the GitHub discussions.

For documentation, check out this document and the official documentation.

Join our community on Discord!

To start using Reviewpad, check out our website.

What is Reviewpad?

Reviewpad is a service to automate pull requests and issues 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 and issues such as:

1. Automated comments;
2. Add or remove labels;
3. Specify reviewer assignments;
4. Automate close/merge actions;
5. Block the merge action;
6. Automatically summarize pull requests;

As an example, the following workflow:

labels:
  ship:
    description: Ship mode
    color: "#76dbbe"

workflows:
  - name: ship
    description: Ship process - bypass the review and merge with rebase
    run:
      - if: $hasFileExtensions([".md"])
        then:
          - $addLabel("ship")
          - $merge()

Automatically adds the label ship and merges all pull requests that only change .md files.

You can execute Reviewpad through the CLI or install Reviewpad GitHub App.

Architecture

This repository generates two artifacts:

1. CLI cli that runs Reviewpad open source edition.
2. 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

Conceptually, the packages are divided into four categories:

1. Engine: The engine is the package responsible for 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.
2. Aladino Language: This is the language that is used in the spec property 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 support for a new language such as Javascript or Golang in these specifications.
3. 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.
4. Utilities: packages, such as the collector, that provide utilities that are used in multiple places.

Development

Prerequisites

Before you begin, ensure you have met the following requirements:

• Go with the minimum version of 1.16.
• goyacc used to generate Reviewpad Aladino parser (go install golang.org/x/tools/cmd/goyacc@master).
• libgit2 with version v1.2.
• To run the tests, Reviewpad requires the following environment variables:
  • INPUT_SEMANTIC_SERVICE. You can do this by running the following command in your terminal: export INPUT_SEMANTIC_SERVICE="0.0.0.0:3006".
  • INPUT_ROBIN_SERVICE. You can do this by running the following command in your terminal: export INPUT_ROBIN_SERVICE="0.0.0.0:3011".
  • INPUT_CODEHOST_SERVICE. You can do this by running the following command in your terminal: export INPUT_CODEHOST_SERVICE="0.0.0.0:3004".

Compilation

We use Taskfile. To compile the packages simply run:

task build

To generate the CLI run:

task build-cli

This command generates the binary reviewpad-cli which you can run to try Reviewpad directly.

The CLI has the following argument list:

./reviewpad-cli
reviewpad-cli is command line interface to run reviewpad commands.

Usage:
  reviewpad-cli [command]

Available Commands:
  check       Check if input reviewpad file is valid
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  run         Runs reviewpad

Flags:
  -f, --file string   input reviewpad file
  -h, --help          help for reviewpad-cli

Use "reviewpad-cli [command] --help" for more information about a command.

Running unit tests

Run the tests with:

task test

If you get the error:

panic: httptest: failed to listen on a port: listen tcp6 [::1]:0: socket: too many open files [recovered]
        panic: httptest: failed to listen on a port: listen tcp6 [::1]:0: socket: too many open files

You can solve with:

ulimit -Sn 500

Coverage

To generate the coverage report run:

task test

To display the code coverage for every package run:

go tool cover -func coverage.out

To display the total code coverage percentage run:

go tool cover -func coverage.out | grep total:

Running integration tests

The integration tests run Reviewpad on an actual repository and pull request. The repository where the integration tests run requires the following setup:

• At least one milestone;
• At least 3 labels named bug, documentation, wontfix (GitHub adds these labels to every new repository by default);
• A team called integration-test with at least 3 members;
• A project called [INTEGRATION TESTS] Reviewpad with Todo and In Progress status
• A GitHub status check called log event.

Required Environment Variables

• GITHUB_INTEGRATION_TEST_TOKEN : GitHub access token used to setup tests and run Reviewpad
• GITHUB_INTEGRATION_TEST_REPO_OWNER : The owner of the repository used to run integration tests on
• GITHUB_INTEGRATION_TEST_REPO_NAME : The name of the repository used to run integration tests on

After setting these variables, you can run the integration tests with:

task integration-test

VSCode

We strongly recommend using VSCode with the following extensions:

• Go for Go language support.
• EditorConfig to helps to maintain consistent coding styles.
• licenser for adding license headers.
• YAML for enabling reviewpad.yml JSON schema.
• JSON Parse & Stringify for formatting JSON files.

Open the project in VSCode, open the command palette (Ctrl+Shift+P) and search for Preferences: Open Workspace Settings (JSON).

Paste the following configuration:

{
    // 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.",
    // Associate Reviewpad schema to reviewpad.(yml|yaml) files
    "yaml.schemas": {
        "https://raw.githubusercontent.com/reviewpad/schemas/main/latest/schema.json": [
            "reviewpad.yml",
        ]
    },
    // Go configuration
    "go.testFlags": [
        "integration"
    ],
    "go.buildFlags": [
        "-tags=integration"
    ],
}

Debugging with VSCode

Add the following to your .vscode/launch.json.

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Launch CLI",
            "type": "go",
            "request": "launch",
            "mode": "debug",
            "args": [
                "run",
                // Flag to run on dry run (optional. Default is false)
                "-d",
                // Flag to run on safe mode (optional. Default is false)
                "-s",
                // Flag to define the log level (optional. Default is debug)
                "-l=debug",
                // GiHub personal access token.
                // To generate a token, go to https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token.
                "-t=<GIT_HUB_TOKEN>",
                // Absolute path to reviewpad.yml file to run.
                "-f=<PATH_TO_REVIEWPAD_FILE>",
                // GitHub URL of the pull request / issue.
                // The reviewpad.yml file provided with the -f flag will run against this pull request / issue.
                // This URL should be same the URL of the pull request / issues in the GitHub event provided with the -e flag.
                // For instance, if you are using a GitHub event of a comment on the pull request X, the -u flag should be the URL of the pull request X.
                "-u=<GITHUB_URL>",
                // Absolute path to JSON file with GitHub event.
                // This GitHub event body defines the action that will run on the pull request / issue.
                // To get the GitHub event body, follow the instructions on https://github.com/reviewpad/reviewpad#how-to-get-the-github-event-body-internal-use-only
                "-e=<PATH_TO_GITHUB_EVENT_BODY>"
                // The GitHub event type
                // Determines how the events JSON file will be processed
                // To get the GitHub event body, follow the instructions on https://github.com/reviewpad/reviewpad#how-to-get-the-github-event-type-internal-use-only
                "-y=<GITHUB_EVENT_TYPE>"
            ],
            "env": {
                "INPUT_CODEHOST_SERVICE": "<CODEHOST_SERVICE_ENDPOINT>",
                "INPUT_SEMANTIC_SERVICE": "<SEMANTIC_SERVICE_ENDPOINT>",
                "INPUT_ROBIN_SERVICE": "<ROBIN_SERVICE_ENDPOINT>",
            },
            "program": "${workspaceFolder}/cli/main.go"
        }
    ]
}

How to get the GitHub event body (internal use only)

The -e flag is mandatory to run the debugger.

It represents the GitHub event that you wish to run the reviewpad.yml file against.

To extract a GitHub event, please follow the steps below:

1. Navigate to the GitHub URL of the pull request you want to test against.
2. Click on the reviewpad check under the Checks tab.
3. From the DETAILS section of the check copy the Delivery ID.
4. Go to the logs of the Entry Gate and filter out the logs using the query {$.delivery_id="[Delivery ID]" && $.msg="request received"}
5. Copy the content inside the body field.
6. Create a file under cli > debugdata with a name that ends with .json (e.g. my_event.json) and paste the content inside the file.
7. This content is an escape JSON string. Use the JSON Parse & Stringify extension to parse the content by pressing Ctrl+Shift+P and searching for JSON: Parse Stringified JSON.
8. Update the argument -e to point to the full path of the file you just created.

How to get the GitHub event type (internal use only)

The -y flag is mandatory to run the debugger.

It represents the type of GitHub event that you wish to run the reviewpad.yml file against.

To get the GitHub event type, please follow the steps below:

1. Navigate to the GitHub URL of the pull request you want to test against.
2. Click on the reviewpad check under the Checks tab.
3. From the DETAILS section of the check copy the Event Type.
4. Paste the content inside the -y flag.

If you wish to use the logs of the Entry Gate to the event type, please follow the steps below:

1. Filter out the logs using the query {$.delivery_id="[Delivery ID]" && $.msg="request received"}
2. Copy the content inside the headers.X-GitHub-Event field.
3. Paste the content inside the -y flag.

Contributing

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.

License

Reviewpad is available under the GNU Lesser General Public License v3.0 license.

See LICENSE for the full license text.

Compliance