Skip to content

agrc/reminder-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Reminder Action

Push Events

About

Based on the probot reminder bot that no longer works. Now in a 2 part github action form! One action to create the reminder metadata and label. And another to run on a schedule to let you know when your reminder is due.

This action requires the use of agrc/create-reminder-action as well.

Use the /remind slash command to set a reminder on any comment box on GitHub and you'll get a ping about it again when the reminder is due.

Use any form of /remind me [what] [when], such as:

  • /remind me to deploy on Oct 10
  • /remind me next Monday to review the requirements
  • /remind me that the specs on the rotary girder need checked in 6 months

Sample Usage

Tip

Add issues: write and pull-requests: write if you intend to use reminders in pull requests and issues.

name: 'check reminders'

on:
  schedule:
    - cron: '10 * * * *'

permissions:
  issues: write
  pull-requests: write

jobs:
  reminder:
    runs-on: ubuntu-latest

    steps:
      - name: check reminders and notify
        uses: agrc/reminder-action@v1

About

A scheduled GitHub action that looks for reminders in issues and pull requests to send reminder notifications

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Contributors 5