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:

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"

Popular Sources

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

Examples

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

Demo video

Please see the video by @codeSTACKr.

Contributing

Please see CONTRIBUTING.md for getting started with the contribution. Make sure that you follow CODE_OF_CONDUCT.md while contributing and engaging in the discussions. When contributing, please first discuss the change you wish to make via an issue on this repository before making the actual change.

ToDo

• Add more sources
• Fix bugs if any

Bugs

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

Thanks

• Thanks to all the existing users of this workflow
• Thanks to all the contributors
• Thanks to @codeSTACKr for this amazing video

Liked it?

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