BirthdayReminder 是一个聪明又贴心的“生日小秘书”。它住在 GitHub 上,利用 GitHub Actions 的自动化超能力,每天准时帮你检查是否有好友或家人过生日。一旦发现目标,它就会通过 企业微信机器人,悄咪咪地给你发来温馨提醒,确保你永远不会错过任何一个重要的祝福时刻!
它独特地支持公历与农历生日,理解“冬月”、“廿二”这样的传统表达,还能设置提前 N 天提醒,让你有充足的时间准备惊喜。再也不用担心忘记生日啦!
- ⏰ 智能定时检查:依托 GitHub Actions,实现每日自动运行,无需自备服务器,稳定可靠。
- 📅 农历/公历双支持:完美适配中国传统农历生日,支持“正月-初一”、“冬月-廿二”等多种格式。
- 🔔 灵活提前提醒:可配置全局或个人专属的提前提醒天数(如提前 3 天、7 天),当天生日也绝不遗漏。
- 💬 多平台消息推送:通过企业微信机器人发送通知,消息可直接在微信中接收,简单方便。
- 🎯 信息清晰明了:提醒消息明确告知“今天”还是“N天后”,区分公历农历,公历生日还会附上星座信息。
- ⚙️ 配置简单直观:所有生日信息和提醒规则,只需在一个
JSON配置文件中管理,一目了然。
只需简单 4 步,即可拥有你的私人生日管家:
点击 GitHub 页面右上角的 Fork 按钮,将此仓库复制到你自己的账户下。
- 打开 手机版企业微信,创建一个只有你(或需要接收消息的成员)的群聊。
- 点击群聊右上角
···->添加群机器人->新建。 - 为机器人取个名(例如:“生日管家”),创建成功后,完整复制弹出的
Webhook地址并保存。地址格式类似:
https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=一串密钥
- 进入你 Fork 后的仓库,点击
Settings->Secrets and variables->Actions。 - 点击
New repository secret,创建一个新的密钥:- Name:
WEWORK_WEBHOOK_URL - Value: 粘贴你刚才复制的 Webhook 地址。
- Name:
- 点击
Add secret保存。
编辑仓库中的 config/birthdays.json 文件,按以下格式添加需要提醒的人员信息:
{
"globalSettings": {
"defaultAdvanceNoticeDays": [0, 3, 7]
},
"people": [
{
"name": "张三",
"birthdayType": "solar",
"birthday": "12-25",
"advanceNoticeDays": [0, 1, 3]
},
{
"name": "李四",
"birthdayType": "lunar",
"birthday": "冬月-廿二"
}
]
}