DEV Community

loading...

How to Add Your Recently Published Articles to Your GitHub Profile README using GitHub Actions

iamdarshshah profile image Darsh Shah 3 min read

Do you want to show off your articles on GitHub?

If you said YES, Then you're at the right place. By the end of this article, you'll have your latest articles listed on your GitHub Profile README.

TL;DR - Before we begin, You must have your GitHub account and make sure you've created your GitHub profile. If not, you can check this article by Monica Powell.

嘴et's Begin!!!

If you're new to GitHub Actions, go check out the official documentation.

We'll be using blog-post-workflow GitHub Action by Gautam krishna R.

How to use this GitHub Action?

  1. Visit your GitHub Profile README repository
https://github.com/{USER-NAME}/{USER-NAME}
Enter fullscreen mode Exit fullscreen mode
  1. You'll need to add the following section to your README.md file
#  Latest Blog Posts // You can name it whatever you want.
<!-- BLOG-POST-LIST:START -->
<!-- BLOG-POST-LIST:END -->
Enter fullscreen mode Exit fullscreen mode
  1. Now, create a folder .github in the root directory & within that directory create another folder named workflows. Now, inside the workflows directory create a new YAML file blog-post-workflow.yml. This is how your folder structure should look like:
.github 
   workflows
            blog-post-workflow.yml
Enter fullscreen mode Exit fullscreen mode
  1. Add the following content in the blog-post-workflow.yml file
name: Latest blog post workflow
on:
    schedule: # Run workflow automatically
      # This will make it run every hour
      - cron: '0 * * * *' 
     # Run workflow manually (without waiting for the cron to be called), through the Github Actions Workflow page directly
    workflow_dispatch: 
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:
            # Replace this URL with your rss feed URL/s
            feed_list: "https://iamdarshshah.hashnode.dev/rss.xml"
Enter fullscreen mode Exit fullscreen mode
  1. Commit your code and wait for your actions to run automatically or here are the steps to trigger it manually:
  • Click on Actions:
    Capture.PNG

  • Now, Click on Latest blog post workflow:
    Capture-1.PNG

  • Then, click on Run workflow to trigger the GitHub Action:
    Capture-3.PNG

NOTE: You can add any popular blogging platform's RSS feed URL. (List of Platforms)

This is it! We did it.

Now, you can check your GitHub Profile README that lists your latest published articles.

This is How it should look

cover image

儭 If you want to customize your GitHub Action, then have a look at all available options you can provide custom values to.

Thanks, for reading it till the end.


Hope you find it useful! Let me know your thoughts on this in the comments section. Don't forget to share this article with your friends or colleagues. Feel free to connect with me on any of the platforms below!

Twitter | LinkedIn | GitHub


References:

Discussion

pic
Editor guide
Collapse
nicolasomar profile image
Nicol獺s Omar Gonz獺lez Passerino

Great work there Darsh. I will have it in mind for the near future.
Good idea to make a more developed readme