Blog post workflow

How to use

1. Star this repo 😉

2. Go to your repository

3. Add the following section to your README.md file, you can give whatever title you want. Just make sure that you use `` in your readme. The workflow will replace this comment with the actual blog post list:

   # Blog posts
   
   
   

4. Create a folder named .github and create a workflows folder inside it, if it doesn't exist.

5. Create a new file named blog-post-workflow.yml with the following contents inside the workflows folder:

   name: Latest blog post workflow
   on:
     schedule: # Run workflow automatically
       - cron: '0 0 * * *' # Runs once a day at 00:00 UTC
     workflow_dispatch: # Run workflow manually (without waiting for the cron to be called), through the GitHub Actions Workflow page directly
   permissions:
     contents: write # To write the generated contents to the readme
   
   jobs:
     update-readme-with-blog:
       name: Update this repo's README with latest blog posts
       runs-on: ubuntu-latest
       steps:
         - name: Checkout
           uses: actions/checkout@v4
         - name: Pull in dev.to posts
           uses: gautamkrishnar/blog-post-workflow@v1
           with:
             feed_list: "https://dev.to/feed/gautamkrishnar,https://www.gautamkrishnar.com/feed/"
   

6. Replace the above URL list with your own RSS feed URLs. See popular-sources for a list of common RSS feed urls. Commit the changes.

   Note on workflow frequency: The default schedule above runs once daily at 00:00 UTC, which is suitable for most users. You can adjust the schedule based on how frequently you publish content:

   • Daily: cron: '0 0 * * *' (recommended for most users)
   • Weekly: cron: '0 0 * * 0' (every Sunday at 00:00 UTC)
   • Monthly: cron: '0 0 1 * *' (1st day of every month at 00:00 UTC)

   Running the workflow too frequently (e.g., hourly) may be unnecessary unless you publish content very often. You can always trigger the workflow manually using workflow_dispatch whenever needed.

7. Go to repository settings, Click on Actions > General. Update the "Workflow permissions" to "Read and write permissions". Click on save.

8. Wait for it to run automatically, or you can also trigger it manually to see the result instantly. To trigger the workflow manually, please follow the steps in the video.

Options

This workflow has additional options that you can use to customize it for your use case. The following are the list of options available:

| Option | Default Value | Description