GitHub ProfileのREADMEにAchievements実績バッジを表示する方法【lowlighter/metrics】

GitHubプロフィールに、自分のGitHub活動に基づいた「実績バッジ」を表示できます。

Achievementsの例

この記事では、lowlighter/metricsのachievementsプラグインを使って、GitHub Actionsで自動的にバッジ画像を生成・更新する方法を解説します。

必要なもの：

GitHubアカウント
プロフィール用リポジトリ（ユーザー名と同名のリポジトリ）

手順の流れ：

Personal Access Tokenを作成
リポジトリにSecretとして登録
GitHub Actionsワークフローを設定
README.mdに画像を埋め込む

NOTE
achievementsプラグインの詳細は公式ドキュメントを参照してください。

IMPORTANT
下記issueのバグが報告されていますが、まだmergeされていないため dkhokhlov/metricsを使用する方針で解説しています（2026年1月3日現在） https://github.com/lowlighter/metrics/issues/1706

1. Personal Access Token の作成#

https://github.com/settings/tokens にアクセス

Tokens (classic) を選択
Generate new token → Generate new token (classic)
以下のscopeにチェック：
- repo
- read:user
- read:project
Generate token をクリック
表示されたトークンをコピー（一度しか表示されない）

NOTE
Fine-grained tokenはGraphQL APIに対応していないため、Classic tokenを使用してください

2. リポジトリにSecretを登録#

リポジトリの Settings > Secrets and variables > Actions を開く
New repository secret をクリック
Name: METRICS_TOKEN、Secret: コピーしたトークンを入力
Add secret をクリック

3. ワークフローファイルの作成#

.github/workflows/metrics.yml を作成：

1
name: Metrics
2
on:
3
  schedule:
4
    - cron: "0 0 * * *"  # 毎日0時に実行
5
  workflow_dispatch:  # 手動実行も可能
6

7
jobs:
8
  github-metrics:
9
    runs-on: ubuntu-latest
10
    permissions:
11
      contents: write
12
    steps:
13
      - uses: dkhokhlov/[email protected]
14
        with:
15
          filename: achievements.svg
16
          token: ${{ secrets.METRICS_TOKEN }}
17
          base: ""
18
          plugin_achievements: yes

4. ワークフローを実行#

リポジトリの Actions タブを開く
左のサイドバーから Metrics を選択
Run workflow をクリック

成功すると、リポジトリのルートに achievements.svg がコミットされます。

5. README.md に画像を追加#

README.md に以下を追記：

1
![Achievements](./achievements.svg)

オプション設定#

オプション	説明	例
`plugin_achievements_threshold`	表示するランク閾値（S/A/B/C/X）	`B`
`plugin_achievements_display`	表示スタイル	`compact` / `detailed`
`plugin_achievements_limit`	表示数の上限	`10`
`plugin_achievements_only`	表示する実績を限定	`polyglot, stargazer`

1
- uses: dkhokhlov/[email protected]
2
  with:
3
    filename: achievements.svg
4
    token: ${{ secrets.METRICS_TOKEN }}
5
    base: ""
6
    plugin_achievements: yes
7
    plugin_achievements_threshold: B
8
    plugin_achievements_display: compact

1. Personal Access Token の作成#

2. リポジトリにSecretを登録#

3. ワークフローファイルの作成#

4. ワークフローを実行#

5. README.md に画像を追加#

オプション設定#

関連記事

年始なのでGitHubプロフィールを更新する

GitHubプロフィールにヘビのアニメーションを追加する

GitHubのリポジトリURL、末尾に追加するだけで色々見れるやつ