Shogo's Blog

Jul 5, 2023 - 1 minute read - github

GitHubのプロジェクトにUsed by counterを追加する

GitHubのプロジェクトを見に行くと、サイドバーに「Used by(数字)」と書かれたセクションがあります。

Used by 2.4k

これの設定方法を知ったのでメモ。

TL;DR

  1. レポジトリのナビゲーションバーから「Setting」をクリックし設定画面を開きます
  2. サイドバーから「Code security and analysis」を選択します
  3. 「Used by counter」という項目で、たくさん使ってもらっていそうなパッケージを選択します

Used by counterからパッケージ選択する

背景

GitHub Actions上でFuzzingを実行するアクションを書いたshogo82148/actions-go-fuzzというGitHub Actionを作りました。 このために作ったレポジトリの概要を眺めていると、いつの間にか「Used by 3」という表示が増えてました。 これ自体はおかしなことではありません。お試しで自分が過去に作ったレポジトリにshogo82148/actions-go-fuzzを導入したので、依存しているレポジトリは存在します。

ずっと不思議だったのは、自分の作った他のGitHub Actionにはこの表示がないこと。 たとえば「actions-setup-perl」でGitHubを検索すると、それなりに使用例が出てきます。 しかし、shogo82148/actions-setup-perlには(この文章を書く前の時点では)「Used by(数字)」のセクションはありませんでした。

原因

ただの趣味でやっているので別に利用者がいなくたって構わないんですが、 やっぱり利用者がいるとモチベーションが変わってくるじゃないですか。 そういうわけで、表示方法を探したところ公式ドキュメントにたどり着きました。

ドキュメントによると、ひとつのレポジトリで複数のパッケージを提供していると、 このようなことが起こるそうです。

shogo82148/actions-setup-perlの場合、GitHubの依存解析によって「JavaScriptのパッケージ」「GitHub Actionのパッケージ」の2つが検出されました。 shogo82148/actions-setup-perlはTypeScriptで実装されているので「JavaScriptのパッケージ」として認識されるのは仕方のないことです。 しかし、利用者はみんなGitHub Actionとして利用するので、実際に「JavaScriptのパッケージ」として利用する人はいません。 というかそういう使い方は想定していないので、使われていないのは正しい。 利用者がいないので、「Used by(数字)」の表示がなかったんですね。

ドキュメントに記載されている通り、「Used by counter」の設定を変更すれば無事表示されます。 shogo82148/actions-setup-perlも「GitHub Actionのパッケージ」としてカウントされるよう設定を変更したので、 この記事を書いている時点では利用者数が表示されるようになりました。

まとめ

  • GitHubのレポジトリで利用者数が表示されるアレは「Used by counter」という名前らしい
  • 設定の「Code security and analysis」から変更できるよ

個人的に「Code security and analysis」から変更できるというのは盲点でした。 「security」の文字だけ見て「セキュリティー関連の設定かー」と思っていたんですが、 なるほど「Code analysis(コード分析)」の設定も含まれているんですね。

レポジトリの設定多すぎて覚えきれないよ・・・。

参考