Blog post workflow

List your latest blog posts from different sources on your Github profile/project readme automatically using this github action:

How to use

• Go to your repository
• Add the following section to your README.md file, you can give whatever title you want. Just make sure that you use <!-- BLOG-POST-LIST:START --><!-- BLOG-POST-LIST:END --> in your readme. The workflow will replace this comment with the actual blog post list:

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

• Create a folder named .github and create workflows folder inside it if it doesn't exist.
• Create a new file named blog-post-workflow.yml with the following contents inside the workflows folder:

name: Latest blog post workflow
on:
  schedule:
    # Runs every hour
    - cron: '0 * * * *'

jobs:
  update-readme-with-blog:
    name: Update this repo's README with latest blog posts
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: gautamkrishnar/blog-post-workflow@master
        with:
          feed_list: "https://dev.to/feed/gautamkrishnar,https://www.gautamkrishnar.com/feed/"

• Replace the above url list with your own rss feed urls. See popular-sources for a list of common RSS feed urls.
• Commit and wait for it to run

Options

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

Option	Default Value	Description	Required
feed_list	""	Comma separated list of RSS feed urls, eg: https://example1.com,https://example2.com	Yes
max_post_count	5	Maximum number of posts you want to show on your readme, all feeds combined	No
readme_path	./README.md	Path of the readme file you want to update	No
gh_token	your github token with repo scope	Use this to configure the token of the user that commits the workflow result to GitHub	No
comment_tag_name	BLOG-POST-LIST	Allows you to override the default comment tag name (<!-- BLOG-POST-LIST:START --><!-- BLOG-POST-LIST:END -->), if you want to show multiple instances of the action on the same repo, see advanced usage for more info	No
commit_message	Updated with the latest blog posts	Allows you to customize the commit message	No
committer_username	blog-post-bot	Allows you to customize the committer username	No
committer_email	blog-post-bot@example.com	Allows you to customize the committer email	No

Advanced usage examples

StackOverflow example

Following configuration allows you to show your latest StackOverflow activity along with your latest blog posts in the Github profile or project readme:

• Follow the steps mentioned in how to use section
• Add the following section to your README.md file, you can give whatever title you want. Just make sure that you use <!-- STACKOVERFLOW:START --><!-- STACKOVERFLOW:END --> in your readme. The workflow will replace this comment with the actual StackOverflow activity:

# StackOverflow Activity
<!-- STACKOVERFLOW:START -->
<!-- STACKOVERFLOW:END -->

• Create stack-overflow-workflow.yml in your workflows folder with the following contents, replace 4214976 with your StackOverflow user id:

name: Latest stack overflow activity
on:
  schedule:
    # Runs every 5 minutes
    - cron: '*/5 * * * *'

jobs:
  update-readme-with-stack-overflow:
    name: Update this repo's README with latest activity from StackOverflow
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: gautamkrishnar/blog-post-workflow@master
        with:
          comment_tag_name: "STACKOVERFLOW"
          commit_message: "Updated readme with the latest stackOverflow data"
          feed_list: "https://stackoverflow.com/feeds/user/4214976"

See the result!

Popular Sources

Following are the list of some popular blogging platforms and their RSS feed urls:

Name	Feed URL	Comments	Example
Dev.to	https://dev.to/feed/username	Replace username wih your own username	https://dev.to/feed/gautamkrishnar
Wordpress	https://www.example.com/feed/	Replace wih your own blog url	https://www.gautamkrishnar.com/feed/
Medium	https://medium.com/feed/@username	Replace @username with your medium username	https://medium.com/feed/@khaosdoctor
Stackoverflow	https://stackoverflow.com/feeds/user/userid	Replace wih your StackOverflow UserId	https://stackoverflow.com/feeds/user/5283532
Ghost	https://www.example.com/rss/	Replace wih your own blog url	https://blog.codinghorror.com/rss/
Drupal	https://www.example.com/rss.xml	Replace wih your own blog url	https://www.arsenal.com/rss.xml
Youtube Playlists	https://www.youtube.com/feeds/videos.xml?playlist_id=playlist_id	Replace playlist id with your own	https://www.youtube.com/feeds/videos.xml?playlist_id=PLJNqgDLpd5E69Kc664st4j7727sbzyx0X

Examples

• My own GitHub profile readme - YML File
• Lucas Santos' GitHub profile readme - YML File

ToDo

• Add more sources
• Fix bugs

Bugs

If you are experiencing any bugs, don’t forget to open a new issue.

Liked it?

Hope you liked this project, don't forget to give it a star ⭐