GitHub コントリビューション Snake アニメーション：設定、SVG、README 掲載

GitHub コントリビューション Snake アニメーションとは？

GitHub コントリビューション Snake アニメーションは、GitHub がアカウントに表示するコントリビューショングラフを素材にした画像です。蛇がカレンダーのマスを進み、プロフィール README に埋め込める SVG や GIF を出力します。これは表示のレイヤーであり、コントリビューションを増やしたり、欠けた活動を直したり、リポジトリの履歴を書き換えたりするものではありません。

広く利用されている Platane/snk の公式リポジトリには、GIF と SVG の生成、ユーザー名と出力先を渡す GitHub Action の例があります。dist/github-snake.svg のようなファイルをプロフィール README のリポジトリにコミットできます。SVG だけを速く生成する Action も案内されています。

Snake が空に見えるときは、まず公式プロフィールのグラフを見ます。メールアドレスの紐付け、対象ブランチ、フォーク、リポジトリの条件、非公開コントリビューションの表示設定、GitHub の処理待ちによって、コミット一覧とプロフィールの表示が一致しないことがあります。元のグラフが不完全なら、画像を何度生成しても不完全なデータを動かすだけです。

固定画像が必要なら コントリビューション PNG ガイドを、プロジェクトやリンクを含む README 全体を整えたいなら プロフィール README ガイドを参照してください。Snake の役割は、カレンダーを小さく印象的な動く素材にすることです。

GitHub コントリビューション Snake アニメーションを設定する方法

生成ファイルの場所を固定し、更新を担当する Workflow を一つにすると設定を保守しやすくなります。公式 Action の書式を出発点にして、README を公開するリポジトリの構成に合わせます。

Snake のファイル、出力、更新チェック

動く部分は小さくても、Workflow、生成ファイル、README、元のプロフィールグラフは別の役割を持ちます。Workflow はいつ実行するかを決め、生成ファイルが出力になり、README が公開表示になります。元のグラフは入力データの確認場所です。

スケジュール実行で活動を反映できますが、成功した実行がすべてのローカルコミットを表示するとは限りません。GitHub の集計処理を待つ必要があり、Action が非公開または集計対象外の活動を読むこともできません。ファイルの更新日時は保守の手がかりであり、作業量の証明ではありません。

README の読みやすさも確認します。アニメーションの近くに短い説明やテキストリンクを置き、動きを見られない読者には SVG や PNG などの固定的な代替を用意します。画像でプロジェクトの説明やドキュメントを隠さないことが大切です。

Snake と他の GitHub コントリビューション画像の違い

同じデータを使っても、目的は異なります。読者の疑問に必要な最小の画像を選び、ルールやプロジェクトの証拠が必要なら詳しいガイドへ誘導します。

GitHub の Snake が空、または古いままになる理由

空の Snake は、元のグラフ、Workflow の出力、README の URL のどこかに原因があります。この順序で確認します。まず公開プロフィールのカレンダーを見て、次に Actions の実行ログでファイルが生成されたかを確認し、最後にキャッシュされたプロフィールではなくコミット済みファイルの URL を直接開きます。

グラフに活動がない場合は、コミットのメールアドレス、到達したブランチ、リポジトリまたはフォークの条件、非公開活動の表示設定、GitHub の処理遅延を確認します。リポジトリのコミット履歴とプロフィールグラフは別の仕組みなので、一方に表示されてももう一方にすぐ出るとは限りません。

グラフは正しいのに画像が古い場合は、Workflow のトリガー、スケジュール、Action のログ、出力先、README が参照するブランチを確認します。ファイルがあるのに古い画像が見えるなら、raw URL と同名ファイルの重複を調べ、キャッシュが更新される時間を置いてから設定を変更します。