Create a repository with the same name as your GitHub username if it's not already done.

The README.md of it will be displayed on your user profile :

From the Developer settings of your account settings, select Personal access tokens to create a new token.

No additional scopes are needed.

Go to the Settings of your personal repository to create a new secret and paste your freshly generated GitHub token there.

Create a new workflow from the Actions tab of your personal repository and paste the following :

name: GitHub metrics
on:
  # Schedule updates
  schedule: [{cron: "0 * * * *"}]
  push: {branches: "master"}
jobs:
  github-metrics:
    runs-on: ubuntu-latest
    steps:
      # See action.yml for all options
      - uses: lowlighter/metrics@latest
        with:
          # Your GitHub token
          token: ${{ secrets.METRICS_TOKEN }}
          # GITHUB_TOKEN is a special auto-generated token restricted to current repository, which is used to push files in it
          committer_token: ${{ secrets.GITHUB_TOKEN }}

See all supported options in action.yml.

When using a token with additional permissions, it is advised to fork this repository to minimize security risks :

      - uses: my-github-username/metrics@latest

In this case, consider watching new releases of this repository to stay up-to-date and enjoy latest features !

If you prefer examples rather than theory, check out this workflow file which generates metrics daily.

It is possible to use @master instead of @latest to use new features before their official release. Breaking changes may occur occasionally on @master, which could result in your metrics not being generated temporarily.

A new metrics image will be generated and committed to your repository on each run.

Edit your repository readme and add your metrics image :

![GitHub metrics](https://github.com/my-github-user/my-github-user/blob/master/github-metrics.svg)

Since GitHub API has rate limitations, the shared instance has a few limitations :

• Images are cached for 1 hour
  • Your generated metrics won't be updated during this amount of time when queried
• A rate limiter is enabled, although it won't affect already cached users metrics
• Plugins which consume additional requests, or require additional token scopes are disabled

If you're appreciating this project, consider using it as a GitHub Action instead.

You will need a server where you can setup and run a NodeJS application.

From the Developer settings of your account settings, select Personal access tokens to create a new token.

No additional scopes are needed, unless you want to include your private repositories metrics or if you want to use the traffic plugin.

Be sure to enable Include private contributions on my profile in your account settings to include your private repositories :

Connect to server and ensure NodeJS is installed (see tested version in workflow).

Run the following commands to clone this repository, install dependencies and copy configuration example file :

git clone https://github.com/lowlighter/metrics.git
cd metrics/
npm install --only=prod
cp settings.example.json settings.json

Edit settings.json to configure your instance.

{
  //See settings.example.json for all options
  //GitHub API token
    "token":"****************************************"
}

See all supported options in settings.example.json.

Run the following command to start your instance once you've finished configuring it :

npm start

From your browser, you should be able to access your web instance on the port you provided in setting.json.

Edit your repository readme and add your metrics image from your server domain :

![GitHub metrics](https://my-personal-domain.com/my-github-user)

To ensure that your instance will be restarted in case of reboots or crashs, you should setup it as a service. This is described below for linux-like systems which supports systemd.

Create a new service file /etc/systemd/system/github_metrics.service and paste the following after editing paths inside :

[Unit]
Description=GitHub metrics
After=network-online.target
Wants=network-online.target

[Service]
Type=simple
WorkingDirectory=/path/to/metrics
ExecStart=/usr/bin/node /path/to/metrics/index.mjs

[Install]
WantedBy=multi-user.target

Reload services, enable it, start it and check if it is up and running :

systemctl daemon-reload
systemctl enable github_metrics
systemctl start github_metrics
systemctl status github_metrics

The following errors code can be encountered on a web instance :

Generated metrics images from a web instance can be configured through url parameters.

Base content is enabled by default, but passing ?base=0 will disable all base content. You can choose to selectively enable or disable a specific <section> with ?base.<section>=<1|0>.

For example, to opt-out from activity, community and metadata, append ?base.activity=0&base.community=0&base.metadata=0 to your metrics url.

Plugins are disabled by default, but passing ?<plugin>=1 will enable a specific <plugin>. Plugin options can be passed with ?<plugin>.<option>=<value>.

For example, to enable music plugin and configure music plugin, you could append the following to your metrics url : ?music=1&music.provider=spotify&music.mode=recent&music.limit=4.

Basically, most of action.yml options can actually be used by web instance, with plugin_ prefix dropped, and . instead of _.

By default, generated metrics contains the following sections :

• header, which usually contains your username, your two-week commits calendars and a few additional data
• activity, which contains your recent activity (commits, pull requests, issues, etc.)
• community, which contains your community stats (following, sponsors, organizations, etc.)
• repositories, which contains your repositories stats (license, forks, stars, etc.)
• metadata, which contains informations about generated metrics

You can explicitely opt-out from them, which can be useful if you only want to keep a few sections or to use a plugin as standalone.

For example, to keep only header and repositories sections, add the following to your workflow :

- uses: lowlighter/metrics@latest
  with:
    # ... other options
    base: "header, repositories" # opt-out from "activity", "community" and "metadata"

Although not mandatory, you can generate an API key for PageSpeed API here to avoid 429 HTTP errors.

The website attached to the GitHub profile will be the one to be audited. Expect 10 to 30 seconds to generate the results.

Add the following to your workflow :

- uses: lowlighter/metrics@latest
  with:
    # ... other options
    plugin_pagespeed: yes
    plugin_pagespeed_token: ${{ secrets.PAGESPEED_TOKEN }}

You can display a detailed report along with scores :

See performance scoring and score calculator for more informations about how PageSpeed compute these statistics.

Add the following to your workflow instead :

- uses: lowlighter/metrics@latest
  with:
    # ... other options
    plugin_pagespeed: yes
    plugin_pagespeed_detailed: yes
    plugin_pagespeed_token: ${{ secrets.PAGESPEED_TOKEN }}

It will consume two additional GitHub requests.

Add the following to your workflow :

- uses: lowlighter/metrics@latest
  with:
    # ... other options
    plugin_isocalendar: yes

Use the following instead to display a full-year instead :

- uses: lowlighter/metrics@latest
  with:
    # ... other options
    plugin_isocalendar: yes
    plugin_isocalendar_duration: full-year

Select a music provider below for instructions.

<iframe allow="" frameborder="" height="" style="" sandbox="" src="https://embed.music.apple.com/**/playlist/********"></iframe>

- uses: lowlighter/metrics@latest
  with:
    # ... other options
    plugin_music: yes
    plugin_music_provider: apple
    plugin_music_mode: playlist
    plugin_music_playlist: https://******** # Extracted source link
    plugin_music_limit: 4 # Set the number of tracks you want to display

<iframe src="https://open.spotify.com/embed/playlist/********" width="" height="" frameborder="0" allowtransparency="" allow=""></iframe>

- uses: lowlighter/metrics@latest
  with:
    # ... other options
    plugin_music: yes
    plugin_music_provider: spotify
    plugin_music_mode: playlist
    plugin_music_playlist: https://******** # Extracted source link
    plugin_music_limit: 4

Select a music provider below for additional instructions.

https://accounts.spotify.com/authorize?client_id=********&response_type=code&scope=user-read-recently-played&redirect_uri=https%3A%2F%2Flocalhost

(async () => {
  console.log(await (await fetch("https://accounts.spotify.com/api/token", {
    method:"POST",
    headers:{"Content-Type":"application/x-www-form-urlencoded"},
    body:new URLSearchParams({
      grant_type:"authorization_code",
      redirect_uri:"https://localhost",
      client_id:"********",
      client_secret:"********",
      code:"********",
    })
  })).json())
})()

{
  "access_token":"********",
  "expires_in": 3600,
  "scope":"user-read-recently-played",
  "token_type":"Bearer",
  "refresh_token":"********"
}

- uses: lowlighter/metrics@latest
  with:
    # ... other options
    plugin_music: yes
    plugin_music_provider: spotify
    plugin_music_token: "${{ secrets.SPOTIFY_CLIENT_ID }}, ${{ secrets.SPOTIFY_CLIENT_SECRET }}, ${{ secrets.SPOTIFY_REFRESH_TOKEN }}"
    plugin_music_mode: recent
    plugin_music_limit: 4

Add the following to your workflow :

- uses: lowlighter/metrics@latest
  with:
    # ... other options
    plugin_languages: yes

Add the following to your workflow :

- uses: lowlighter/metrics@latest
  with:
    # ... other options
    plugin_followup: yes

This uses puppeteer to navigate through your starred topics page.

You can choose to display and order topics by :

• Most stars
• Recent activity
• Recently starred by you
• randomly

Add the following to your workflow :

- uses: lowlighter/metrics@latest
  with:
    # ... other options
    plugin_topics: yes
    plugin_topics_sort: stars
    plugin_topics_limit: 15

It will consume an additional GitHub request.

Add the following to your workflow :

- uses: lowlighter/metrics@latest
  with:
    # ... other options
    plugin_projects: yes
    plugin_projects_limit: 4

Note that by default, profile projects have progress tracking disabled. To enable it, open the ≡ Menu and edit the project to opt-in to Track project progress (it can be a bit confusing since it's actually not in the project settings).

It will consume an additional GitHub request per repository.

Add the following to your workflow :

- uses: lowlighter/metrics@latest
  with:
    # ... other options
    plugin_lines: yes

It will consume an additional GitHub request per repository.

Because of GitHub REST API limitation, provided token requires full repo scope to access traffic informations.

Add the following to your workflow :

- uses: lowlighter/metrics@latest
  with:
    # Token with "repo" scope
    token: ${{ secrets.METRICS_TOKEN }}
    # ... other options
    plugin_traffic: yes

It will consume an additional GitHub request per event fetched.

Because of GitHub REST API limitation, provided token requires full repo scope to access private events. Events that cannot be fetched will be ignored so it is still possible to use this plugin with a scope-less token.

Add the following to your workflow :

- uses: lowlighter/metrics@latest
  with:
    # ... other options
    plugin_habits: yes
    plugin_habits_from: 100

Supported sources are :

• dev.to

Add the following to your workflow :

- uses: lowlighter/metrics@latest
  with:
    # ... other options
    plugin_posts: yes
    plugin_posts_source: ********

It will consume an additional GitHub request per gist fetched.

Add the following to your workflow :

- uses: lowlighter/metrics@latest
  with:
    # ... other options
    plugin_gists: yes