https://github.com/miyagawa/hubot-cron

Crontab like scheduling messages for Hubot
https://github.com/miyagawa/hubot-cron

Last synced: 17 days ago
JSON representation

Crontab like scheduling messages for Hubot

• Host: GitHub
• URL: https://github.com/miyagawa/hubot-cron
• Owner: miyagawa
• Created: 2012-10-30T19:42:11.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2019-11-20T22:50:00.000Z (almost 5 years ago)
• Last Synced: 2024-10-17T23:56:46.302Z (25 days ago)
• Language: CoffeeScript
• Homepage:
• Size: 423 KB
• Stars: 214
• Watchers: 10
• Forks: 47
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md

Awesome Lists containing this project

README

        
# hubot-cron

hubot-cron adds a cronjob system to hubot to schedule messages on a specific date and time.

## Installation

Add `hubot-cron` to your package.json, run `npm install` and add hubot-cron to `external-scripts.json`.

Add hubot-cron to your `package.json` dependencies.

```

"dependencies": {

  "hubot-cron": ">= 0.1.0"

}

```

Add `hubot-cron` to `external-scripts.json`.

```

> cat external-scripts.json

> ["hubot-cron"]

```

If you want to specify timezones, you'll need to install the [time](https://github.com/TooTallNate/node-time) module or place an entry for it in your package.json file.

    npm install time

## Usage

```

miyagawa> hubot new job 0 9 * * 1-5 "Good morning everyone!"

hubot> Job 12345 created

miyagawa> hubot list jobs

hubot> (list of jobs)

miyagawa> hubot rm job 12345

hubot> Job 12345 removed

miyagawa> hubot tz job 12345 America/Los_Angeles

hubot> Job 12345 updated to use America/Los_Angeles

```

You can use any [node-cron](https://github.com/ncb000gt/node-cron) compatible crontab format to schedule messages. Registered message will be sent to the same channel where you created a job.

To persist the cron job in the hubot restart, you're recommended to use redis to persist Hubot brain.

Timezones are specified in [tzdata format](https://en.wikipedia.org/wiki/Tz_database#Examples).

## See Also

`reminder.coffee` in hubot-scripts.