review-reminder-action

A reminder that add labels and mention reviewers when pull requests become stale.

Created from the following template

advanced-typescript-action

Usage

1. Create .github/workflows/review-reminder.yml in your repository.

2. Add the following code to the file.

name: Review Reminder

on:
  schedule:
    - cron: '0 0 * * *'

jobs:
  review-reminder:
    permissions:
      contents: read
      pull-requests: write
    runs-on: ubuntu-latest
    steps:
      - name: Run review reminder
        uses: thundermiracle/review-reminder-action@v1
        with:
          stale-days: 2
          reminder-labels: |-
            need review

Configuration

You can configure the action with environment variables.

Name	Description	Required	Type	Default
stale-days	The days that pull requests become stale.		number	2
base-branch	The base branch of pull requests.(nothing means all pull requests are targets)		string
reminder-labels	The labels that will be added to pull requests. eg: ['need review', 'need help']		String Array
send-reminder-comment	Send comment with mentions for pull request reviewers when the pull request needs review.		boolean	true
only-business-days	Only count business days when calculating the stale days.		boolean	true
ignore-draft	Ignore draft pull requests.		boolean	true
skip-approve-count	Skip reminder when pull request has been approved by at least this many reviewers. 0 for no skip.		number	0
token	The token to use for authentication.		string	github.token

License

The scripts and documentation in this project are released under the MIT License