
A self-updating GitHub profile README
A self-updating GitHub profile README GitHub has a hidden feature: if you create a repository with the same name as your username, its README is displayed directly on your profile page. It's essentially a personal landing page, but in markdown. The catch is that it gets stale fast — every time you finish a new project, you have to remember to update it manually. I didn't want to do that. So I automated it. How it works The portfolio website already exposes all my projects through an API endpoint at /api/projects . Each project has a title, description, URL, and a featured flag. That's all the data needed to keep the README up to date. A GitHub Actions workflow runs on a schedule — every hour — and does the following: Fetches the latest projects from larsniet.com/api/projects Filters them using jq : featured projects go into one list, everything else into another Injects the generated content into the README between a pair of HTML comment markers using awk Commits and pushes the result
Continue reading on Dev.to Tutorial
Opens in a new tab




