DEV Community

Cover image for Update your GitHub profile with your games with a GitHub Action
Leonardo Montini for This is Learning

Posted on • Updated on • Originally published at

Update your GitHub profile with your games with a GitHub Action

When navigating through GitHub you may land on awesome profiles with "live" content being updated automatically, what kind of sorcery is this?

Let's start from the beginning! game history

Setup a personal profile

On top of the basic GitHub profile with pinned repos and the (very cool) contribution chart, you can fully customize the content in markdown basically by writing a file, of your profile.

All you have to do is create a new repository with your username and put a file in it.

In my case, my username is Balastrong so the repo will be Balastrong/Balastrong.

GitHub badge

GitHub already notices that by adding this little badge in the home of your repo.

Bring it to life with GitHub Actions!

I'm sure you know the existence of GitHub Actions. Well, they can be used to edit files in your repository, right?

Now, the file you're going to edit is and it will fetch some content from the internet, before formatting and putting it into your file. games! logo

Now that we have the combination profile + actions, we can make the magic!

All you need is to use this action: Games & Stats [Marketplace], [Repository].

You can find the instruction there!
In short, you just need to two two basic steps:

1. Setup a placeholder in your

You can control where the data will appear by putting this inside your file:


Enter fullscreen mode Exit fullscreen mode

2. Setup the action

GitHub helps you setting up a new action, but anyway it's just adding a new file in .github/workflows in your repository and that's it.

The content is as simple as:

name: Chess Stats Action

    - cron: '0 0 * * *' # Runs at 00:00 UTC every day

    name: Update readme with your chess stats and games
    runs-on: ubuntu-latest
      - uses: actions/checkout@v3
      - uses: Balastrong/chess-stats-action@master
          CHESS_USERNAME: <Your Username>
Enter fullscreen mode Exit fullscreen mode

Just replace <Your Username> and you're good to go!

With the current cron schedule it will run by itself ad midnight UTC, but thanks to workflow_dispatch you can also run the action manually at any time.

You can see a live example at the bottom of my profile:

Getting the games

Here some additional context on the APIs, you might be curious about it! has some APIs but not exactly a complete game list. An official source of info is their Developer Community.

For some reason, you can only get the games already grouped by year/month, in the format:{username}/games/{YYYY}/{MM}
Enter fullscreen mode Exit fullscreen mode

They call this "archive".

You can also get a list of available archives for a player:{username}/games/archives
Enter fullscreen mode Exit fullscreen mode

Since my goal was to get the last N games and I cannot know how many games an archive has, I decided to request the archives first, and then call them one by one until I get the desired amount of games (or I requested 5 archives, that's enough).

Aaand... it kind of works :)

Thanks for reading my post, I hope you find it interesting!
Feel free to follow me to get notified when new articles are out ;)

You can also follow me on GitHub or Twitter, you can find the links here directly on my GitHub profile!

Hello, Leonardo here 👋

I'm a π-shaped Frontend Developer, Open Source enthusiast and content creator.

I enjoy constantly learning new things and sharing knowledge with others. You can find my content on my YouTube Channel and on my blog.

I've also been awarded as GitHub Star in 2023 🌟

Let's get in touch! You can find me on:

youtube logo twitter logo discord logo linkedin logo devto logo

My latest YouTube videos on my channel Dev Leonardo

Where's the Hacktoberfest 2023 T-Shirt & Swags? Level up your GitHub Issues What makes Smart Working Succesful Learn Web Development with a Real Project GIT Flight Rules to save your repository Sum an Array in Javascript with reduce

📕 Top projects I've contributed to

vscode vscode-js-debug qwik-ui date-fns zod orama

♟️ Are you a Chess player? You should check out chess-stats-action 😉

Learning or improving your Web Development skills? Let's do it together with the github-stats project!

Top comments (1)

balastrong profile image
Leonardo Montini

Thanks for reading this article!

Do you want to know more or dirty your hands and contribute to the project? There are a few open issues in the repo, if you want to give it a look here's the url:

You can also leave there a star, much appreciated!
The programming language used is Typescript in case you were wondering :D