Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: reviewpad onboarding #10

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: reviewpad onboarding #10

wants to merge 1 commit into from

Conversation

reviewpad[bot]
Copy link

@reviewpad reviewpad bot commented Apr 25, 2023

Reviewpad-Thin-Logo-Simple

Welcome to Reviewpad! This is an onboarding pull request to help you configure Reviewpad before it starts speeding up and securing your pull requests.

To activate Reviewpad, merge this Pull Request. To disable Reviewpad, simply close this Pull Request unmerged.

Configuration

Reviewpad is configured by adding a reviewpad.yml to the root of your repository. This file contains a list of workflows that Reviewpad will use to automate actions on your pull requests. Each workflow is triggered based on some defined conditions called rules.

To get you started, we provide a default configuration (attached to this PR) with some best practices.

If you wish to tune this configuration, you can either use our embedded wizard by turning on/off the below checkboxes or simply edit the reviewpad.yml file in this branch and push it. If you decide to manually update the reviewpad.yml configuration file to get access to the full power of Reviewpad, the wizard and so the below checkboxes will vanish.

Please make sure to test your configuration before pushing it. You can run your configuration against a public repository using our Reviewpad Playground.

The workflows part of this default configuration are the following:

  • Summarize the pull request on each push;
  • Assign the pull request to the most relevant reviewers based on code authorship and reviewer availability;
  • Greet contributors on their first pull request;
  • Check conventional commits:
  • Best practices for pull request management:
    • Warn pull requests that do not have an associated GitHub issue;
    • Warn pull requests if their description is empty;
    • Warn pull requests that do not have a linear history (i.e. commits come after one another);
  • Label pull requests based on their size to boost smaller pull requests;
  • Label pull requests with waiting-for-review if there missing approvals;
  • Label pull requests based on the type of changes:
    • Label pull requests with docs if they only modify Markdown or txt files;
    • Label pull requests with infra if they modify Terraform files;
    • Label pull requests with dependencies if they only modify package.json and package.lock files;
  • Fail Reviewpad check on pull requests that modify any LICENSE;

What to Expect

With your current configuration, Reviewpad will perform the following automations in the last 2 open pull requests:

Need help?

If you have any questions please check out our documentation or get in touch with us.


This PR has been generated by Reviewpad and it was triggered by the installation of the Reviewpad GitHub App.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Message that will be displayed on users' first pull request

@reviewpad
Copy link
Author

reviewpad bot commented Apr 25, 2023

Reviewpad Report (Reviewpad ran in dry-run mode because configuration has changed)

📜 Executed actions

$assignCodeAuthorReviewers(1, [], 0)
$commitLint()
$titleLint()
$warn("Please link an issue to the pull request")
$removeLabels(["small", "large"])
$addLabel("medium")
$addLabel("waiting-for-review")

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants