きり丸の技術日記

技術・エンジニアのイベント・資格等はこちらにまとめる予定です

GitHubに連携しているソースをIntelliJ IDEAからブラウザで開く(Jump to the GitHub version of a file)

私の中ではよく使うユースケースですので、忘れないようにメモ。


ブログを書いていると、記事に出現したソースをGitHubにPushし、ブログ側にリンクを張ることがよくあります。

その際に、masterではなくコミットハッシュ値付でリンクを張ることで、GitHub側を修正してもリンク切れを起こさずに済みます。パッケージを移動したり、リネームするともう前者のリンクは使えなくなるので、エンジニアブログを書く人は必須テクニックだと思ってます。私の古い記事はリンク切れを起こして、どのファイルを指しているのか分からないものが発生してしまいました…。

しかし、普通にブラウザからコミットハッシュ値付きのリンクを取得するのは非常に面倒です。※簡単にリンクを取得できる方法ありました。最後に記します。

IntelliJ IDEAでは、このコミットハッシュ値付きのリンクを簡単に取得できますので、ぜひ使ってみてください。

なお今までもできていたのですが、IntelliJ IDEAを2020.3にアップデートしてからメニューの位置が変わってしまっているので、自身のバージョンを意識してください。

環境

  • IntelliJ IDEA Ultimate Edition
    • 2020.3
    • (2020.2以前)

※ Community Editionでも同様の機能を提供しているかは、確認していません。

ユースケース

  • IntelliJ IDEAのユーザー
  • ブログ等の長期的にリンクへのソースを残したい人

手順

2020.3の場合


ソースを右クリックしたのち、「Open In」を選択して「GitHub」を選ぶだけです。そうすると、ブラウザで対象のハッシュコミット値のソースを開きます。

f:id:nainaistar:20210114224157p:plain

また、右クリックをしたソースの位置で、末尾に「#LXX」が付与されます。例えば「#L31」だと31行目が選択されている状態でブラウザが表示されます。複数行を選択している状態では、「#LXX-LXX」となり複数行が選択されている状態でブラウザが表示されます。

次のリンクをクリックすると、次の画像の状態で開かれます。

https://github.com/hirotoKirimaru/LeetCode/blob/1d28dfa277207f7302b26ddd37f70c8c623e31b3/src/main/java/com/example/leetCode/_283.java#L36-L35

f:id:nainaistar:20210114224215p:plain

2020.2以前の場合


※ 2020.3のバージョンの画像です。

一番下が「Create Gist」となっています。この下から2番目にハッシュコミット付きリンクを取得できるメニューがありました。

f:id:nainaistar:20210114224157p:plain

その他


メニューが見つからない場合は、Actionsから「Open on GitHub」で開いてください。こちらでも利用できます。

f:id:nainaistar:20210114224231p:plain

ブラウザでハッシュコミット付きURLを取得する方法

ぶどうぐみさんに教えていただきました。

GitHubで目的のソースを開いた状態で「y」を入力すると、コミットハッシュ付のURLが取得できます。この機能知らなかったです。

教えていただき感謝です!

終わりに

機能は分かっても、右クリックのメニュー一覧がヘルプで見つからなくて困りました。まさか、「Open In」にあるとは…。

この記事もアップデートですぐに使えなくなるかもしれませんが、ブログを書き続けている限りはこの機能を追っていこうと思います。


この記事がお役に立ちましたら、各種SNSでのシェアや、今後も情報発信しますのでフォローよろしくお願いします。

参考

IntelliJ Idea:Jump to GitHub Version www.jetbrains.com

f:id:nainaistar:20210126190844p:plain