https://github.com/peixin/robot-friday
https://github.com/peixin/robot-friday
cloudfunction diff fei-shu lark qi-ye-wei-xin reminder robot tencent-scf wework workday
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/peixin/robot-friday
- Owner: peixin
- Created: 2020-10-24T10:05:33.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-01-16T00:40:42.000Z (over 3 years ago)
- Last Synced: 2025-01-07T12:14:50.143Z (5 months ago)
- Topics: cloudfunction, diff, fei-shu, lark, qi-ye-wei-xin, reminder, robot, tencent-scf, wework, workday
- Language: JavaScript
- Homepage:
- Size: 118 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
## `Friday` Robot for Team.
基于云函数的 企业微信/飞书 机器人事件提醒
Cloud Function based WeCom/Lark robot message notification
**Office Assistant `Friday`**
### Capability
- Workday code review reminders
- Reminder of weekend transfer
- Reminder of standup everyday
- Reminder of holiday
### Capability
- WeCom 企业微信
- Lark 飞书
### Setup
- `yarn run pack`
- Tencent Cloud create SCF function
- upload `robot-friday-v${version}.zip` to scf function
- Or use Github Action see [.github](https://github.com/peixin/robot-friday/tree/master/.github/workflows)
- 'Upload Method' select 'Install dependencies online'
- Set environment variable
* DEFAULT_TIMEZONE=Asia/Shanghai
* MENTIONED_MOBILE_LIST=phone num 1|phone num 2|... // for wecom
* MENTIONED_LIST=user ID 1|user ID 2|... // for wecom
* MENTIONED_USER_IDS=user ID 1|user ID 2|... // for lark
* PLATFORMS=lark|wecom
* LARK_ROBOT_HOOK_URL=...
* WECOM_ROBOT_HOOK_URL=...
- Set trigger
* extra information
* workingDayOnWeekend: remind if tomorrow is weekend but need to go to work
* diff: workday remind diff
e.g.
```
name: StandUpMeeting
cron syntax: 0 30 9 * * * *
extra information: StandUpMeeting
name: Diff
cron syntax: 0 0 14 * * * *
extra information: Diff
name: HolidayGreeting
cron syntax: 0 30 8 * * * *
extra information: HolidayGreeting
name: WorkingDayOnWeekend
cron syntax: 0 0 18 * * FRI,SAT *
extra information: WorkingDayOnWeekend
```
### Reference
- [WeCom Robot](https://work.weixin.qq.com/api/doc/90000/90136/91770)
- [Lark Robot](https://www.feishu.cn/hc/zh-CN/articles/360024984973)
- [crontab guru](https://crontab.guru/)
- [chinese-holidays-data](https://github.com/bastengao/chinese-holidays-data)