How to Automatically Show Latest Blog Posts in Your GitHub Profile README

The blog-post-workflow is a GitHub Action that reads your blog's RSS feed and updates a designated section of your README with your most recent posts. It runs on a schedule (daily by default) and commits the updated post list automatically, so your profile always reflects your current writing without any manual intervention.

The Action supports filtering posts by tag, controlling how many posts to display, customizing the post item format, and pulling from multiple RSS feeds simultaneously. It works with any valid RSS 2.0 or Atom feed, making it compatible with virtually every blogging platform that exists.

Follow these steps:

1. Add comment markers to your README where you want the post list to appear:

## Recent Blog Posts
<!-- BLOG-POST-LIST:START -->
<!-- BLOG-POST-LIST:END -->

2. Create .github/workflows/blog-post-workflow.yml:

name: Latest Blog Post Workflow
on:
  schedule:
    - cron: '0 0 * * *'
  workflow_dispatch:
jobs:
  update-readme-with-blog:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: gautamkrishnar/blog-post-workflow@v1
        with:
          feed_list: "https://yourblog.com/rss.xml"

3. Replace https://yourblog.com/rss.xml with your actual RSS feed URL.
4. For Dev.to: https://dev.to/feed/YOUR_USERNAME
5. For Medium: https://medium.com/feed/@YOUR_USERNAME
6. Run the workflow manually from Actions to trigger the first update.

The Action accepts several configuration options:

• max_post_count: Number of posts to display (default: 5)
• feed_list: Comma-separated list of RSS feed URLs for multiple sources
• template: Custom format for each post item (supports $title, $url, $date, $newline variables)
• tag_post_pre_newline: Whether to add a newline before each item
• disable_sort: Set to true to keep posts in feed order rather than sorting by date
• filter_comments: Filter posts that are comment responses (for Dev.to)
• comment_tag_name: Change the comment markers if your README uses different names

Example custom template:

template: "- [$title]($url) — $date"

For multiple feeds (e.g., Dev.to + personal blog):

feed_list: "https://dev.to/feed/username,https://yourblog.com/rss.xml"

If the workflow runs but your README doesn't update, verify that the comment markers in your README are exactly <!-- BLOG-POST-LIST:START --> and <!-- BLOG-POST-LIST:END --> on their own lines. Any extra text on those lines will prevent the regex match.

If the Action fails with 'No valid RSS data found', test your RSS feed URL directly in your browser. Some platforms generate feed URLs differently — Dev.to uses https://dev.to/feed/USERNAME (not the usual /feed.xml pattern). For Hashnode blogs, the feed URL is typically https://YOURBLOG.hashnode.dev/rss.xml.

If the workflow runs successfully but commits show no changes, your RSS feed may not have been updated since the last run. This is expected behavior — the Action only commits when new posts are available.