Skip to content

ページを編集した人のGitHubアイコンを表示 (close #83) - #107

Open
rotarymars wants to merge 3 commits into
cpprefjp:masterfrom
rotarymars:contributors_github_icons
Open

rotarymars wants to merge 3 commits into
cpprefjp:masterfrom
rotarymars:contributors_github_icons

Conversation

@rotarymars

Copy link
Copy Markdown
Member

各ページの最終更新者の下に、そのページを編集した人のGitHubアイコンを
最終編集日時が新しい順に並べ、GitHubのユーザーページへリンクする。

  • 編集者の一覧は git log を1回だけ実行して全ページ分をまとめて集計する
    • users.noreply.github.com 形式のメールアドレスはそこから直接取り出す
    • それ以外は GitHub API (GET /repos/{owner}/{repo}/commits/{sha}) で コミットの author.login を取得する。
    • 結果は .github_users.cache にJSONでキャッシュする
  • 環境変数 GITHUB_TOKEN があればAPIの認証に使う (docker.shrunでコンテナに引き継ぐ)。 レート制限に達した場合は打ち切り、残りは次回解決する
  • 同じアカウントの複数メールアドレスは1人にまとめ、botは除外する
  • GitHubアカウントと紐付かない人は汎用アイコンで表示する
  • settings に GITHUB_REPO を設定したサイトのみ有効 (cpprefjp で有効化)

各ページの最終更新者の下に、そのページを編集した人のGitHubアイコンを
最終編集日時が新しい順に並べ、GitHubのユーザーページへリンクする。
- 編集者の一覧は git log を1回だけ実行して全ページ分をまとめて集計する
  - users.noreply.github.com 形式のメールアドレスはそこから直接取り出す
  - それ以外は GitHub API (GET /repos/{owner}/{repo}/commits/{sha}) で
    コミットの author.login を取得する。
  - 結果は <setting>.github_users.cache にJSONでキャッシュする
- 環境変数 GITHUB_TOKEN があればAPIの認証に使う
  (docker.shrunでコンテナに引き継ぐ)。
  レート制限に達した場合は打ち切り、残りは次回解決する
- 同じアカウントの複数メールアドレスは1人にまとめ、botは除外する
- GitHubアカウントと紐付かない人は汎用アイコンで表示する
- settings に GITHUB_REPO を設定したサイトのみ有効 (cpprefjp で有効化)
@rotarymars

Copy link
Copy Markdown
Member Author

1つ懸念事項なのですが、contributorが増えたときにリストが途中でカットされる仕様になっていないのですが、ページによっては長くなりすぎるかもしれないです。

@rotarymars
rotarymars force-pushed the contributors_github_icons branch from 0347c54 to 0550b72 Compare November 18, 2026 00:34
@faithandbrave

Copy link
Copy Markdown
Member

ありがとうございます!とりあえずローカルで動かしてみます!

@faithandbrave

Copy link
Copy Markdown
Member

7500ページ超のauthor取得で0.5秒程度のようなので、変換速度としては問題なさそうです。

モバイルだとアイコンが潰れて縦長になってしまうようでした。

表示人数としては、新しい順に最大10人にして、それを超えてる場合には…とか+とかの丸アイコンを表示するとかですかね。

スクリーンショット 2026-11-19 17 00 32

以下、Claude Codeからの指摘です。


  1. 本番ビルドでは GITHUB_TOKEN が渡らず、ほぼ全員が汎用アイコンになる

docker.sh に -e GITHUB_TOKEN を足していますが、本番の生成は cpprefjp/site の build.yml → .github/workflows/script/build.sh が python3 run.py settings.cpprefjp を直接叩いており、docker.sh を通りません。build.yml の該当ステップに GITHUB_TOKEN: ${{ github.token }} が無いので、未認証 (60/時、しかも Actions の共有 IP) になります。

さらに site_generator は毎回まっさらにチェックアウトされ、キャッシュファイルは gitignore されているので、毎ビルドが常にコールドキャッシュです。つまり現状のままマージすると、本番は毎回 60 件前後しか解決できず、大半が灰色の人型アイコンで出ます。

  • cpprefjp/site 側に GITHUB_TOKEN を渡す PR が併せて必要
  • キャッシュの永続化 (actions/cache、またはキャッシュを gitignore から外してリポジトリに持つ) も検討したほうがよい
  1. 同じ人が2回出る (278ページ)

メールアドレスが GitHub アカウントに紐付かない人は、別のメールで紐付いている分とは別人として扱われます。実データで melpon・nekko1119・Daisuke Sugiyama の3名が該当し、278ページで「アバター1個+灰色アイコン1個」が同じ表示名で並びます。implementation-status では実際にそうなっています。

解決できなかった場合に %aN (著者名) でまとめ、同名で解決済みの login があればそれを使う、というフォールバックを入れるのが簡単だと思います。

  1. 狭い画面でアバターが潰れる

kunai の div[itemtype="http://schema.org/Article"] .edit-button .text-right { display: inline-flex } に、新しい <p class="text-right contributors"> も一致します。その結果 flex アイテムが縮み、アイコンが 20×20 ではなく 13.4×20 の楕円になります。

閾値は「アイコン数 × 23px > コンテンツ幅」。1040px のビューポートで29個がちょうど収まる (667px) ので、デスクトップでもウィンドウを少し狭めると崩れます。ただし実際に29人いるのは implementation-status だけで、10人超が46ページ、16人超は1ページだけなので、影響範囲は限定的です。

text-right クラスを使わない (別名にして自前で text-align: right) か、flex-wrap: wrap と flex-shrink: 0 を指定すれば直ります。

  1. 細かい点
  • collect_page_authors が集めている last_updated はどこからも使われていません (make_page_contributors が捨てている)。消すか、使うかのどちらか
  • 既存の make_commit_info_dict() も全履歴の git log --name-only を舐めています。collect_page_authors の戻り値には最新著者と日時が含まれているので、2回のフル走査を1回にまとめられます
  • --prefix= や差分ビルドで数ページしか生成しない場合でも、全メールアドレスの解決を試みます。プレビュービルドでは無駄な API 呼び出しになります
  • 404 (GitHub 上に無いコミット) を null としてキャッシュするため、後から push されても再問い合わせされません。コメントに明記されてはいます
  • アバターを github.com から読むので、閲覧ページの URL が Referer として GitHub に渡ります。referrerpolicy="no-referrer" を付けておくと無難です
  • README は「各ページの右上に」、PR 説明は「最終更新者の下に」と記述が食い違っています (実際は最終更新者の下、右寄せ)
  • スタイルがインライン属性に直書きです。kunai 側の CSS に寄せたほうが 3 の問題も含めて扱いやすいと思います

画面サイズに合わせ、動的に表示数を調整するようにした。
@rotarymars

Copy link
Copy Markdown
Member Author

95a0078 : 表示するアイコンを画面幅に合わせ数を調整するようにしました。
アイコンのキャッシュ等については、cpprefjp/site#1788 に出させていただきました。
同じユーザーを違う人として表示してしまう問題は b1797fe で修正しました。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants