https://github.com/bhupesh-v/update-pr-reminder-action

A github action to automatically remind contributors to update their branch when there is a new commit in the base branch
https://github.com/bhupesh-v/update-pr-reminder-action

alerting comment github-actions reminders update-pr update-pull-request

Last synced: 6 months ago
JSON representation

A github action to automatically remind contributors to update their branch when there is a new commit in the base branch

• Host: GitHub
• URL: https://github.com/bhupesh-v/update-pr-reminder-action
• Owner: Bhupesh-V
• License: gpl-3.0
• Created: 2022-03-13T13:55:58.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-03-15T16:00:20.000Z (over 3 years ago)
• Last Synced: 2025-04-12T00:43:33.677Z (6 months ago)
• Topics: alerting, comment, github-actions, reminders, update-pr, update-pull-request
• Language: Shell
• Homepage: https://bhupesh.me/automatically-remind-contributors-to-update-pull-request/
• Size: 35.2 KB
• Stars: 9
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          


  
Update PR Reminder Action

  


  
A github action to automatically remind pull request authors to update their branch as soon as there is a new commit (or merge) in the base branch

  


[![PR Update Reminder](https://github.com/Bhupesh-V/update-pr-reminder-action/actions/workflows/self-test.yaml/badge.svg?branch=main)](https://github.com/Bhupesh-V/update-pr-reminder-action/actions/workflows/self-test.yaml)



  



## ✨ Demo

![update-pr-reminder-action-demo](https://user-images.githubusercontent.com/34342551/158306923-519008b8-16ab-4117-a597-2b678ebedabd.png)

#### Checkout [this pull request for demo](https://github.com/Bhupesh-V/update-pr-reminder-action/pull/1)

## ❓ Usage

```yaml

name: PR Update Reminder

on:

  push:

    branches:

      - main

      - dev

env:

  # make sure to set this as env

  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

jobs:

  remind_authors:

    runs-on: ubuntu-latest

    name: Update PR Reminder Test

    steps:

      - uses: actions/checkout@v2

      - uses: Bhupesh-V/update-pr-reminder-action@main

 ```