Pull Request review reminders for MSFT Teams & GitHub

Set the minimum number of reviews needed and ignore head branches by prefix/label.

Open Sourced on GitHub

Install

How It Works

1

Step 1 - Create an Incoming Webhook Connector in your MSFT Teams channel.

Follow these instructions (pasted below) from MSFT for adding a connector to your channel. You'll need the URL you create in the next step.

  • ∙ Navigate to the channel where you want to add the webhook and select (•••) More Options from the top navigation bar.
  • ∙ Choose Connectors from the drop-down menu and search for Incoming Webhook.
  • ∙ Select the Configure button, provide a name (Mariachi), and, optionally, upload an image avatar for your webhook.
  • ∙ The dialog window will present a unique URL that will map to the channel. Make sure that you copy and save the URL—you will need to add it to your mariachi.yml file in the next step.
    • ∙ Eg: https://outlook.office.com/webhook/{string}/IncomingWebhook/{string}
  • ∙ Select the Done button. The webhook will be available in the team channel.

2

Step 2 - Add a mariachi.yml file to set up Mariachi as a GitHub Action (recommended*)

  name: Mariachi
  on:
  schedule:
    - cron: "0 15 * * *" # run every morning (time in GMT)
  jobs:
    remind:
      runs-on: ubuntu-latest
      steps:
      - name: Mariachi
      uses: docker://schlagelk/mariachi:latest
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          teams_url: ${{ secrets.TEAMS_TOKEN }} # your Teams URL from step 1
          exclude_heads: release,test # optional
          exclude_labels: do-not-review,skip-mariachi # optional
          min_reviews: 3 # optional, defaults to 2

*Mariachi does not have to be set up as a GitHub Action - you can use any server you have.
See our repo for more examples

3

Step 3 - Get reminders

Set up Mariachi in no time

Find detailed instructions for setting up Mariachi on our GitHub repo

Need help configuring Mariachi? Send us an email hola@mariachi.app

Mariachi is free and open source

You can support Mariachi by sponsoring the project on GitHub Sponsors

We'll also gladly accept ETH at the following wallet address
0xf6F7D616a481eb76863a29f2787Cf698D7b2CE67