Skip to content

jtalborough/WeekPlanner

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

9 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿ“… WeekPlanner

๐Ÿ“ง An automated weekly PDF delivery system that sends customized PDF templates via email using GitHub Actions.

๐Ÿ”„ Workflow

The system operates on the following automated workflow:

โฐ Scheduling

  • ๐Ÿค– Runs automatically every Monday at 00:00 UTC
  • ๐ŸŽฎ Can also be triggered manually through GitHub Actions

๐Ÿš€ Process

  1. ๐Ÿ” Locates the template PDF file in the repository
  2. โœ๏ธ Renames it with the current week number and date (e.g., "Week01_2025-01-12.pdf")
  3. ๐Ÿ”’ Encodes the PDF for email attachment
  4. ๐Ÿ“จ Sends the email using SendGrid

โš™๏ธ Setup Requirements

๐Ÿ”‘ GitHub Repository Secrets

Required secrets in your repository settings:

  • TO_EMAIL: ๐Ÿ“ฎ Recipient email address
  • FROM_EMAIL: ๐Ÿ“ค Sender email address
  • SENDGRID_API_KEY: ๐Ÿ” Your SendGrid API key

๐Ÿ“„ PDF Template

  • ๐Ÿ“ Place your PDF template in the repository root
  • โœจ Name it with "Template" in the filename

๐ŸŽฏ Manual Trigger

Need to send right away? No problem!

  1. ๐Ÿ–ฑ๏ธ Go to the Actions tab in your GitHub repository
  2. ๐Ÿ“‹ Select "Weekly Email" workflow
  3. โ–ถ๏ธ Click "Run workflow"

๐Ÿ› ๏ธ Technical Details

The workflow is defined in .github/workflows/WeeklySend.yml and uses:

  • ๐Ÿ”„ GitHub Actions for automation
  • ๐Ÿ“ง SendGrid API for email delivery
  • ๐Ÿ”’ Base64 encoding for PDF attachment
  • ๐Ÿง Ubuntu latest as the runner

๐Ÿ“ License

This project is licensed under the MIT License - see the LICENSE file for details.


Made with โค๏ธ using GitHub Actions

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published