Reports

Reviewpad provides reporting capabilities to help you create awareness around your pull requests and insights into the pull requests life cycle.

It offers different types of reports described below.

User-generated report

The first kind of report is the user-generated report created when using the built-ins info, warn, and error in your Reviewpad file.

Example

Here is an example of a Reviewpad file and the report generated when the pull request gets old.

reviewpad.yml

api-version: reviewpad.com/v3.x

workflows:
  - name: long-live
    if:
      # Verify if the pull request was created more than 10 days ago
      - $createdAt() < 10 days ago
    then:
      - $info("This pull request is old. Please consider closing it.")

Executed actions report

The second type of report is the report generated by Reviewpad with the executed actions.

When Reviewpad runs, for each workflow it evaluates the workflow conditions and if the conditions are met it will execute the actions provided in the workflow and append the executed actions to the report. At the end of the run, Reviewpad will generate a report with all the executed actions.

caution

This report is only generated if the mode configuration in your Reviewpad file is set to verbose

Example

Here is an example of a Reviewpad file and the executed actions report generated if all the conditions are met.

reviewpad.yml

api-version: reviewpad.com/v3.x

mode: verbose

workflows:
  - name: validate-linked-issue
    always-run: true
    if:
      - $hasLinkedIssues() == false
    then:
      - $info("This pull request does not have a linked issue")

  - name: validate-description
    always-run: true
    if:
      - $description() == ""
    then:
      - $warn("The description is empty. Please add more information!")
      - $fail("Empty description")

Metrics report

The last type of report is the metrics report, which is generated when a pull request is merged.

This report provides insights into the pull requests life cycle from the moment coding begins up to the time the pull request is merged.

This report contains the following metrics:

• Coding time: the time elapsed between the first commit and the creation of the pull request.
• Pickup time: the time elapsed between the creation of the pull request and the submission of the first review.
• Review time: the time elapsed between the submission of the first review and the merge of the pull request.

caution

This report is only generated if the metrics-on-merge property in your Reviewpad file is set to true

Example

Here is an example of a metrics report generated by Reviewpad when a pull request is merged.