Giter VIP home page Giter VIP logo

reminder-action's Introduction

About this fork

This fork supports reminders on the closed issues. However, contrary to the original repo, it has limited support for the reminder prompts and only supports the following format:

  • /remind [who] to [what] [when] (e.g., /remind me to review this PR in 6 hours)
  • /remind [who] [when] to [what] (e.g., /remind @kublaios in 2 days to address the comments)

Where [when] is recognized only in the following formats: in|after X minute(s)|hour(s)|day(s)|month(s)|year(s)

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

name: 'check reminders'

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

jobs:
  reminder:
    runs-on: ubuntu-latest

    steps:
      - name: check reminders and notify
        uses: agrc/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.

reminder-action's People

Contributors

dependabot[bot] avatar stdavis avatar steveoh avatar kublaios avatar ugrc-release-bot[bot] avatar gjjvdburg avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.