https://github.com/anandchowdhary/birthday-reminders-action
🎁 Daily messages for birthday reminders using GitHub Actions
https://github.com/anandchowdhary/birthday-reminders-action
birthday birthday-reminder github-actions telegram-bot typescript
Last synced: 5 months ago
JSON representation
🎁 Daily messages for birthday reminders using GitHub Actions
- Host: GitHub
- URL: https://github.com/anandchowdhary/birthday-reminders-action
- Owner: AnandChowdhary
- License: mit
- Created: 2022-11-01T10:01:10.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-25T20:39:50.000Z (over 2 years ago)
- Last Synced: 2025-05-07T20:09:30.840Z (5 months ago)
- Topics: birthday, birthday-reminder, github-actions, telegram-bot, typescript
- Language: JavaScript
- Homepage:
- Size: 617 KB
- Stars: 7
- Watchers: 2
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🎁 Birthday Reminders Action
Get daily Telegram messages for birthday reminders using GitHub Actions.
## 🎈 How it works
Using scheduled workflows, you will receive a Telegram message once every day with a list of birthdays, and once every week with upcoming birthdays you should order gifts for.
## 🛠️ Setup
Create a new repository with the following environment variables:
- `TELEGRAM_TOKEN` - Bot token
- `TELEGRAM_CHAT_ID` - Chat ID
Next, create a `birthdays.yml` file with a list of birthdays you want to track:
```yaml
- name: Anand Chowdhary
day: 29
month: 12
year: 1997
- name: Sukriti Kapoor
day: 15
month: 9
gift: true
```
Each person should have a "name" (string), "month" (number), and "day" (number). Optionally, you can add "year" (number) to find out how many years old they are, "gift" (boolean) for whether or not you want to be reminded to purchase a gift, and "me" (boolean) for a wish for yourself.
Then, create two GitHub Actions workflow files. First, `.github/workflows/daily.yml`:
```yaml
name: Daily CI
on:
schedule:
- cron: "0 8 * * *"
workflow_dispatch:
jobs:
weekly:
name: Daily birthday reminders
runs-on: ubuntu-20.04
steps:
- name: Checkout
uses: actions/checkout@v2.3.3
- name: Send message
uses: AnandChowdhary/birthday-reminders-action@HEAD
with:
command: birthdays-today
env:
TELEGRAM_TOKEN: ${{ secrets.TELEGRAM_TOKEN }}
TELEGRAM_CHAT_ID: ${{ secrets.TELEGRAM_CHAT_ID }}
- name: Keep alive
uses: gautamkrishnar/keepalive-workflow@v1
```
In the above example, we've also included [gautamkrishnar/keepalive-workflow](https://github.com/gautamkrishnar/keepalive-workflow) to prevent GitHub from disabling scheduled workflows.
And `.github/workflows/weekly.yml`:
```yaml
name: Weekly CI
on:
schedule:
- cron: "0 8 * * 1"
workflow_dispatch:
jobs:
weekly:
name: Weekly birthday reminders
runs-on: ubuntu-20.04
steps:
- name: Checkout
uses: actions/checkout@v2.3.3
- name: Send message
uses: AnandChowdhary/birthday-reminders-action@HEAD
with:
command: upcoming-birthdays
env:
TELEGRAM_TOKEN: ${{ secrets.TELEGRAM_TOKEN }}
TELEGRAM_CHAT_ID: ${{ secrets.TELEGRAM_CHAT_ID }}
```
You can manually trigger the workflow to test it out.
## 📄 License
- Code: [MIT](./LICENSE) © [Anand Chowdhary](https://anandchowdhary.com)
- "GitHub" is a trademark of GitHub, Inc.