I recently discovered this Github feature where we can have a README.md on our public profile. It works like a personal index for me, where I can share my blog, digital garden, etc.
I saw some people doing very creative pages, and I decided to do a minimalist one for myself :-)
Since I already have a RSS feed on my blog, I wondered if I could build some mechanism to automatically update my README.md with new posts.
And… at the end of the day, it’s quite easy. So, let me show you how you can do that in 2 simple steps!
1) The ‘README.md’ repository
First of all, I created this .github/workflows/build.yml file on my https://github.com/karreiro/karreiro repository.
Notice that I’ve configured the repository to be hourly refreshed. So, every time this job runs, my update_readme.rb Ruby script is triggered, and a new README.md is pushed if there’s something new.
2) The Ruby script
You can write your own script or re-use mine ;-)
I use a “template” file with this {posts} element to hold my posts. It’s quite simple:
The whole logic lives here.
It’s alive!
That’s it! Now, I don’t need to update the README.md by myself anymore! Have you recently done any trivial automation like that? 😅 If so, I’d really like to read about it in the comments.
I hope you’ve enjoyed this quick tutorial!