English · 简体中文
Leverages GitHub Actions to automate the delivery of Calibre News.
Workflow | Environments | Enable/Disable | Destroy
Tip
📹 A Brief Tour: https://youtu.be/sIFsoztF58A
- Create a project in your repositories using this template.
- Navigate to [ Settings > Environments ] in the project.
- Click "New environment" to create a new one called
calibre-news. - Add the required "environment secrets" to it as follows.
| Name | Required | Description | Example |
|---|---|---|---|
| FROM | Yes | Your email address | [email protected] |
| TO | Yes | Destination email address | [email protected] |
| ENCRYPT | Yes | SMTP encryption method | SSL |
| SECRET | Yes | SMTP password | xxxxxxxxxx |
| SMTP | Yes | SMTP server | smtp.gmail.com |
| PORT | Yes | SMTP port | 465 |
| FORMAT | No | The ebook format | epub |
| LIMIT | No | Attachment size limit (MB) | 25 |
- Navigate to "Actions" and click [ Calibre News Delivery > Run workflow ] to test.
The default delivery is scheduled to occur daily at midnight (00:00) UTC. You can change it according to your preference. The cron expression - cron: '0 0 * * *' can be found in the workflow file located at:
/.github/workflows/calibre-news.yml
Please refer to the "schedule" documentation to specify an appropriate time. For example, if you are in a timezone that is UTC+8 and want the delivery to start at 6:00 AM every day, you can set the cron expression as 0 22 * * *, calculated using the formula UTC Time = Local Time − Offset.
Additionally, you can manually trigger the delivery on the "Actions" page of your project.
For the built-in recipes, you need to add their titles (found in the Title attribute of the recipe file) to the plain text file recipe_list.txt, one title per line. For manually written recipes, simply place them in the root of the project.
You can specify the cover and style for a recipe. Place the cover image in the "covers" folder and the style file in the "styles" folder. Both filenames must match the corresponding recipe title or filename. Be aware that the style may be ignored by the Send to Kindle service.
This project does not accept any PRs for adding recipes. Please do something interesting on your own.