agrc / create-reminder-action

A GitHub Action for setting reminders in issues

Create a Reminder Action

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/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

name: 'create reminder'

permissions:
  issues: write

on:
  issue_comment:
    types: [created, edited]

jobs:
  reminder:
    runs-on: ubuntu-latest

    steps:
      - name: 👀 check for reminder
        uses: agrc/create-reminder-action@v1

Package for distribution

GitHub Actions will run the entry point from the action.yml. Packaging assembles the code into one file that can be checked in to Git, enabling fast and reliable execution and preventing the need to check in node_modules.

Actions are run from GitHub repos. Packaging the action will create a packaged action in the dist folder.

1. Semantic version (for major changes, a new v(major) branch is required)

   npm version (minor | patch) --no-commit-hooks --no-git-tag-version

2. Run prepare

   npm run prepare

3. Since the packaged index.js is run from the dist folder.

   git add dist package*.json

4. Commit changes

   git commit -m "release: v1.*.*"

5. Use the draft a release workflow on GitHub.

   • pick a color + pet name generator with the first letter matching the first letter of the color