GitHubプロフィールREADMEにCredly認定バッジを自動反映する

GitHubプロフィールの README に、Credly で取得した認定バッジを自動で表示したくて GitHub Action を作りました。

Marketplace:
https://github.com/marketplace/actions/credly-readme

リポジトリ:
https://github.com/kpab/credly-reeadme

できること

• Credly の公開 JSON からバッジ一覧を取得する
• GitHubプロフィール README の指定区間だけを書き換える
• 差分があるときだけ commit / push する
• 並び順、表示数、画像サイズを指定できる

完成イメージ

プロフィール README に、こんな感じで認定バッジを並べられます。

## Certifications
<!--START_SECTION:badges-->
<!--END_SECTION:badges-->

このマーカー区間の中身を Action が自動更新します。

前提

• GitHubプロフィール用リポジトリ <your-github-username>/<your-github-username> がある
• Credly のプロフィールが公開状態になっている
• README.md を GitHub Actions から更新できるようにする

使い方

まず、プロフィール用リポジトリの README.md にマーカーを置きます。

## Certifications
<!--START_SECTION:badges-->
<!--END_SECTION:badges-->

次に、同じリポジトリへ workflow を追加します。

name: Update Credly Badges

on:
  schedule:
    - cron: "0 2 * * *"
  workflow_dispatch:

permissions:
  contents: write

jobs:
  update:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: kpab/credly-readme@v1
        with:
          credly_user: <your-credly-username>
          sort: LATEST
          badge_width: 100

これで手動実行または定期実行時に、Credly バッジが README に反映されます。

主な入力値

• credly_user: Credly のユーザー名
• readme_path: 更新対象 README。デフォルトは README.md
• section_name: マーカー名。デフォルトは badges
• sort: LATEST / OLDEST / NAME
• max_badges: 表示件数。0 なら全件
• badge_width: バッジ画像の幅
• dry_run: true なら書き込みなしで確認だけできる
• empty_message: バッジが0件のときの表示文言

Marketplace 公開もしました

GitHub Marketplace からそのまま使えます。

README:
https://github.com/kpab/credly-reeadme

まとめ

Credly の認定を GitHubプロフィール README に出したい場合、手で更新し続けるのは地味に面倒です。
GitHub Actions にしておくと、プロフィールの見た目を保ちつつ更新漏れも防げます。

もし同じ用途の人がいれば、ぜひ使ってみてください。