GitHub quietly released a new feature at some point in the past few days: profile READMEs. Create a repository with the same name as your GitHub accou

Simon Willison’s Weblog

submited by
Style Pass
2024-04-30 13:00:02

GitHub quietly released a new feature at some point in the past few days: profile READMEs. Create a repository with the same name as your GitHub account (in my case that’s github.com/simonw/simonw), add a README.md to it and GitHub will render the contents at the top of your personal profile page—for me that’s github.com/simonw

I couldn’t resist re-using the trick from this blog post and implementing a GitHub Action to automatically keep my profile README up-to-date.

Visit github.com/simonw and you’ll see a three-column README showing my latest GitHub project releases, my latest blog entries and my latest TILs.

I’m doing this with a GitHub Action in build.yml. It’s configured to run on every push to the repo, on a schedule at 32 minutes past the hour and on the new workflow_dispatch event which means I get a manual button I can click to trigger it on demand.

It then turns the results from those various sources into a markdown list of links and replaces commented blocks in the README that look like this:

Leave a Comment