GitHub 上でコミットハッシュにもとづく URL を得る

ご存知のかたも多いかと思いますが、GitHub で管理しているコードについて、コードの "ある部分" を示したいときに貼り付ける URL には注意が必要です。

ソースコードの参照リンクを貼るときに気をつけたいこと

たとえばこんなリンクを貼り付けた場合

• https://github.com/tmd45/tmd45.github.io/blob/source/Gemfile#L16

これは source ブランチの最新の Gemfile ファイルの 16 行目を参照します。

いま（記事執筆時点で）このリンクを開くと gem 'slim', '~> 3.0.2' が書かれている行を参照してることがわかりますが、この先 source ブランチのコードに変更があった場合「最新の」コードでは別のものを指してしまう可能性があります。

なので "ある行" を参照する場合にはコミットハッシュを特定した URL を貼るのがベストです。

• https://github.com/tmd45/tmd45.github.io/blob/de6fb7dd0309465b936817e8452948084c8d7c76/Gemfile#L16

この URL はコミットハッシュ de6fb7dd0309465b936817e8452948084c8d7c76 の Gemfile ファイルの 16 行目を参照しているので、コードに変更があってもリンク先の内容が変わってしまうことはありません。

コードの "ある部分" を示したいときにはこの違いに気をつけましょう。

GitHub の便利なショートカット

というわけで、ここまでは自分も当たり前のように実践していたのですが、この「コミットハッシュにもとづく URL」取得のためにいちいち History などから最新のコミットハッシュを辿るということをしていました。面倒。

最近同僚に教えてもらったのですが（そして感動してこの記事を書いているのですが）

GitHub ページ上のショートカット機能により y キーを押すことで、現在見ているファイルのコミットハッシュにもとづく URL を簡単に得ることができます。

以下のページを開いているときに y キーを押すと

• https://github.com/tmd45/tmd45.github.io/blob/source/Gemfile#L16

アドレスバーで以下の URL に変わるのがわかります（コミットハッシュ部分は最新のものに変わります）。

• https://github.com/tmd45/tmd45.github.io/blob/de6fb7dd0309465b936817e8452948084c8d7c76/Gemfile#L16

一発で便利！( ﾟДﾟﾉﾉ"☆ﾊﾟﾁﾊﾟﾁﾊﾟﾁﾊﾟﾁ

ちなみに

GitHub 上で利用できる便利なショートカット機能は ? キーを押すことで GitHub ページ上のどこでも確認できます。

Expand URL to its canonical form

というのが今回のそれですね。t と l はよく使ってたんですが、これは気づいていませんでした(；´∀｀)

"Source code browsing" にあるショートカットは、GitHub 上でコードブラウジングを行う上で非常に便利なので、ぜひ試してみて下さい。