【Eclipse×GitHub】図で解説するGitHubバージョン管理方法
①: ~ 概要編 ~
②: ~ Git操作用語編(初級) ~
③: ~ Git操作用語編(中級) ~
④: ~ Eclipse操作編(事前準備) ~ ← 今ここ
⑤: ~ Eclipse操作編(Git操作実演) ~
前回までにGitの操作を一通り説明してきました。
今回からは統合開発環境として有名なEclipseを使ってGit操作を実演していきたいと思います。
実演編は2部に分け、前編はEclipseでGitが使えるようになるための事前準備の説明をして、後編からGit操作の実演をしていきます。
Eclipseの開発環境がまだ構築できてない方は以下の記事を参考にして開発環境を構築しておきましょう!
また、GitHubはアカウント作成が既に完了していることを前提に話をしていきます。
EGitのインストール
EGitはEclipse用のGitプラグインであり、導入することで前回までに学んできたGit操作をEclipse上で実行できるようになります。
何はともあれ、このツールを導入しないとGitの実演ができなくなってしまうので、インストールしていきましょう!
まずはEclipseを起動し、メニューから「ヘルプ」→「新規ソフトウェアのインストール」をクリックします。
「インストール」画面が立ち上がるので「追加」をクリックします。
「リポジトリーの追加」ダイアログが表示されるので下記のように名前とロケーションを入力し、「追加」をクリックします。
- 名前:任意(ここではEGitと入力)
- ロケーション:https://download.eclipse.org/egit/updates
下記画像のように「Eclipse用Git統合」にチェックを入れ、「次へ」をクリックします。
「次へ」をクリックします。
「使用条件の条項に同意します」をチェックし、「完了」をクリックします。
「再起動」を要求されるので、「今すぐ再起動」をクリックします。
これでEGitのインストールは完了です。
GitHub SSHキー認証設定
2021年8月13日以降、GitHubではGit操作をする際のパスワード認証が廃止され、トークンベースの認証が必要になりました。
そのため、トークンベース認証の設定をしておかないとGit操作が一切できない状態になります。
トークンベース認証にはHTTPSまたはSSHキーを使用した認証がありますが、今回はSSHキー認証の設定してEclipseからGitHubにGit操作ができるようになるまでの設定手順を説明していきます。
まずはSSHキー認証で必要となる公開鍵、秘密鍵の2つのキーペアを作成していきましょう。
キーペアはEclipseで生成することができます。
生成したキーペアのうち、公開鍵はGitHubに登録し、秘密鍵をローカル環境のSSH2ホームフォルダで保管することになります。
では、キーペアの作成と認証設定方法を説明していきます。
Eclipseを起動し、メニューの「ウィンドウ」→「設定」をクリックします。
「設定」画面が立ち上がったら左ペインで「一般」→「ネットワーク接続」→「SSH2」をクリックし、右ペインの「一般」タブを開きます。
SSH2ホームのフォルダを確認します。
このフォルダ配下に秘密鍵を保管することになります。
デフォルトだと「C:\Users\ユーザー名\.ssh」となりますが、変更したい場合は任意のフォルダを指定しておきましょう。
それではキーペアを生成していきます。
「鍵管理」タブを開き、「RSA鍵の生成」をクリックします。
「DSA鍵」、「RSA鍵」とありますが、これは暗号方式の違いになります。
「DSA鍵」はセキュリティが万全ではなく、SSH2では非推奨とされているため、「RSA鍵」を選択しましょう!
すると公開鍵の中身が表示されるのでコピーしておきます。
後でGitHubに公開鍵を登録するときに使います。
パスフレーズの設定は任意になりますが、ここでは何も設定せずに進めていきます。
最後に「秘密鍵の保存」をクリックして秘密鍵を保存します。
この時一緒に公開鍵も保存されます。
EclipseでRSA鍵を生成した場合、そのビット数は「1024」となるようです。
実はビット数1024のRSA鍵もセキュリティが万全でなくSSH2では非推奨とされており、2048以上が推奨されているようです。
ただし、Eclipse上でビット数2048以上のRSA鍵の生成方法が現時点でなさそうなため、もし推奨されている鍵を生成したい場合は他の手段を使用することになります。
パスフレーズはパスワードみたいなもので設定しておくと秘密鍵にアクセスする際にパスフレーズの入力が要求されます。
パスフレーズを設定することで、万が一秘密鍵が漏洩したとしても、不正使用を防ぐことができます。
パスフレーズ保護なしでこの秘密鍵を保存しますか?と聞かれるので「OK」をクリックします。
SSH2ホームに「.ssh」フォルダが存在しなかった場合は「作成しますか?」と聞かれるので「OK」をクリックします。
保存ダイアログが立ち上がるので、ファイル名(デフォルトでは「id_rsa」)を指定し「保存」をクリックします。
正常に保存されると「.ssh」配下に「id_rsa(秘密鍵)」と「id_rsa.pub(公開鍵)」の2つのファイルが生成されているはずです。
秘密鍵は絶対に外部に公開しないようにしましょう!
鍵の生成が完了したら、まずは秘密鍵をEclipseに登録しましょう。
「一般」タブを開き、「秘密鍵」の欄に生成した秘密鍵を登録します。
今回の手順だと「id_rsa」で登録されていればOKです。
次は公開鍵をGitHubに登録していきましょう!
GitHubのSettings画面を開き、「SSH and GPG Keys」をクリックするとSSH keys登録画面が開くので「New SSH key」ボタンをクリックします。
公開鍵登録画面に切り替わるので、下記3つの設定を行った後に「Add SSH key」をクリックします。
- Title:タイトルを記入
- Key type:「Authentication key」を選択
- Key:Eclipseでコピーしておいた公開鍵を貼り付け
下記画面のように登録した鍵が表示されていれば公開鍵の登録完了です。
Gitコミットの設定
EclipseでGit操作する前の事前準備としてGitのユーザー名とメールアドレスを登録しておきましょう。
Eclipseの設定画面を開き、左ペインで「バージョン管理(チーム)」→「Git」→「構成」をクリックします。
次に右ペインの「ユーザー設定」タブを開き、「エントリー追加」をクリックします。
構成エントリーの追加ダイアログが開くので下記の2つを追加します。
キー | 値 |
---|---|
user.name | ユーザー名 |
user.email | GitHubに登録済みのメールアドレス |
下記のように追加されていれば設定完了です。
※メールアドレスの非公開設定
Gitに登録したユーザー名とメールアドレスはコミット等のGit操作した際に履歴やログに残されます。
そしてこれらの履歴やログをGitHubにプッシュすることでGitHubの履歴、ログに反映されます。
つまり何が言いたいかというと、GitHubのリポジトリをPublicで作成している場合、第3者があなたのGitHubリポジトリをクローンし、ログを確認することでメールアドレスが確認できてしまうということです。
この点に配慮して、GitHubではダミーのメールアドレスに置き換えることでメールアドレスの非公開設定を行うことができます。
GitHubのSettings画面を開き、「Emails」をクリックすると「Keep my email addresses private」という項目があるのでここにチェックを入れます。
そうすることでGitHub提供のnoreplyメールアドレスを「user.email」に設定することができるようになります。
無事に事前準備は完了しましたか?
次のページからGit操作の実演をしてきます。
コメント