https://github.com/agrc/create-reminder-action
A GitHub action for setting reminders in issues and pull requests
https://github.com/agrc/create-reminder-action
github-action government-app terraform-managed
Last synced: 20 days ago
JSON representation
A GitHub action for setting reminders in issues and pull requests
- Host: GitHub
- URL: https://github.com/agrc/create-reminder-action
- Owner: agrc
- License: mit
- Created: 2021-06-23T16:17:14.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-21T16:13:02.000Z (29 days ago)
- Last Synced: 2025-04-30T10:34:08.628Z (20 days ago)
- Topics: github-action, government-app, terraform-managed
- Language: JavaScript
- Homepage: https://github.com/marketplace/actions/create-reminder
- Size: 2.64 MB
- Stars: 14
- Watchers: 4
- Forks: 9
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Create a Reminder Action
[](https://github.com/agrc/create-reminder-action/actions/workflows/push.yml)
## About
Based on the [probot reminder bot](https://github.com/probot/reminders/) 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](https://github.com/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 [who] [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`
- `/remind @ to fix this issue tomorrow`
## Sample Usage
```yml
name: 'create reminder'
permissions:
issues: write
pull-requests: 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_)
```bash
npm version (minor | patch) --no-commit-hooks --no-git-tag-version
```
1. Run prepare
```bash
npm run prepare
```
1. Since the packaged index.js is run from the dist folder.
```bash
git add dist package*.json
```
1. Commit changes
```bash
git commit -m "release: v1.*.*"
```
1. Use the draft a release workflow on GitHub.
- [pick a color](https://perchance.org/color-name) + [pet name generator](https://www.namegenerator.co/animals/pet-name-generator) with the first letter matching the first letter of the color