Dev Metrics in Readme

CodeStats Weekly Metrics on your Profile Readme:

Prep work

1. You need to update the markdown file(.md) with 2 comments. You can refer here for updating it.
2. You'll need a CodeStats account.
3. Your profile has to be public. (Settings)

Update your README.md

Add a comment to your README.md like this:

<!--START_SECTION:codestats-->
<!--END_SECTION:codestats-->

These lines will be our entry-points for the dev metrics.

Profile Repository

If you're executing the workflow on your Profile Repository (<username>/<username>)

Please follow the steps below:

1. Go to your <username>/<username>/actions, hit New workflow, set up a workflow yourself, delete all the default content github made for you.

2. Copy the following code and paste it to your new workflow you created at step 1:

   name: CodeStats – README
   
   on:
     workflow_dispatch:
     schedule:
       # Runs at 12am UTC
       - cron: '0 0 * * *'
   
   jobs:
     update-readme:
       name: Update this repo's README
       runs-on: ubuntu-latest
       steps:
         - uses: vergissberlin/codestats-readme@master
           with:
             CODESTATS_USERNAME: <username>
   

3. Add a comment to your README.md like this:

   <!-- START_SECTION:codestats -->
   <!-- END_SECTION:codestats -->
   

4. Go to Workflows menu (mentioned in step 1), click CodeStats Readme, click Run workflow.

5. Go to your profile page. you will be able to see it.

Why only the language stats and not other data from the API?

I am a fan of minimal designs and the profile readme is a great way to show off your skills and interests. The CodeStats API, gets us a lot of data about a person's coding activity. Using up more data via the CodeStats API will clutter the profile readme and hinder your chances on displaying what you provide value to the community like the pinned Repositories. You are exercising these languages or learning a new language, this will also show that you spend some amount of time to learn and exercise your development skills. That's what matters in the end ❤️

Testing

Docker

docker build -t vergissberlin/codestats-readme .
docker run \
  -e INPUT_CODESTATS_USERNAME=vergissberlin \
  -e INPUT_README_FILE=/data/README.md \
  -e INPUT_SHOW_TITLE=true \
  -e INPUT_SHOW_LINK=true \
  -e INPUT_DEBUG=true \
  -v $PWD/tests/fixtures/README.md:/data/README.md \
  -v $PWD:/app \
  vergissberlin/codestats-readme

node

INPUT_CODESTATS_USERNAME=vergissberlin \
INPUT_README_FILE=./tests/fixtures/README.md \
INPUT_SHOW_TITLE=true \
INPUT_SHOW_LINK=true \
node index.js