技術書を書きたくなり、技術書を書く際によく使われるRE:VIEWのセットアップをしようとしてます。Reviewのテンプレートをブランチするためにgitを入れた方がよさそうでしたので、ここではgitの環境構築をしました。
かなり内容は薄いのであくまで自分の備忘録です。環境としてはWindows11です。
gitをインストールする
まず最初にgitのインストーラーをダウンロードします。
次の画面でClick here to downloadというボタンを押下します。これでインストーラーがダウンロードされます。
インストーラがダウンロード出来たら起動します。何も考えずnextを押します。
次にインストールするフォルダを選択します。特に指定が無ければデフォルトのフォルダのまま行きます。
次にコンポーネントの選択画面になります。
私はデフォルトに追加して下記の2つにチェックを入れました。
一つ目のチェックのCheck daily fot Git for Windows updateは名前の通り、毎日アップデートがあるかを確認するものです。毎日確認するのが煩わしいという方は付けなくてもいいと思います。
2つ目のチェックのAdd a Git Bash Profile to Windows TerminalはBashが使えるようになるものです。正直最近はWindows でUbuntuが使えるのでBashは使えなくてもいいかもしれないのですが、せっかくなので入れてみました。
続いてStar MenuのFolderの選択が出てきますが、ここはこだわりがないためそのままで行きます。
続いてデフォルトのテキストエディタの選択を行います。私は普段VS CODEを使っているため、VS CODEを選択しますが、ご自身の環境に併せて選択をお願いします。デフォルトはVimだったので、Git使う人はVimが多いんですかね？Vimの時は文字がきちんと見えていたのですが、VS CODEを選択したら文字が化けました笑 深い意味はないと思いますが
次にリポジトリを作成した場合の初期ブランチ名をどうするか聞かれます。私はOverride the default branch name for new repositoriesの方を選択して"main"を選択しました。
理由としては2020年のgithubのブログでは新しく作成されたリポジトリのデフォルトブランチ名がmainになるという記事に記載されている通り、2020年以降に作られるリポジトリのブランチ名はmainが主流になってます。
もし古いリポジトリを使う場合は、デフォルトが"master"である上側を選択するのが良いと思いますが、特に指定が無い場合はmainを選択するのが一般的みたいです。ただ今回セットアップしているRe:ViewのTemplateは"master"になってます。基本的にgit cloneした場合はテンプレート側の設定が優先されるので、今回は現在の主流であるmainにします。
次に環境変数の設定画面です。今回はコマンドプロンプトなどでもgitコマンドが使えるようにするため推奨の真ん中の設定にします。(一番下はUnix系のコマンドをコマンドプロンプトでも使えるようにするものですが、私は不慣れで事故が起こりそうなので真ん中にしました。)
次にSSHの実行環境を選択する画面が出てきますGitHubなどのサーバーと通信するためのSSHをどうするかというものですが、特に指定が無い場合はデフォルトのままでいいと思います。。
次にSSLの設定です。デフォルトでは下側の方にチェックがついているのですが、Geminiに聞いたところ、特にこだわりが無ければ上側を選択するのが無難とのことだったので、いったん上側の選択肢を選んでます。
https://memoteki.net/archives/5586
一応Gemini曰く、下側は企業内ネットワークなどを使っている人は↓のほうがいいとのことで、個人利用は上側の選択しを選ぶのが無難とのことでした。
次に改行コードの扱いについての選択です。WindowsとLinux系で改行を示すコードが異なります。一番上の設定はファイルをダウンロードする際にGitが自動的にWindowsの改行コードであるCRLFに変換をし、ファイルをコミットする際は逆にLFに戻すような設定です。(途中見切れているのですが、ググったらそのように出てきました。)
Windows以外の人は真ん中のほうがいいかもしれないです。
次に選択するのはGit Bashを操作する際のターミナルの設定です。特にこだわりが無ければMinTTYを選択するのが無難です。(下側はWindowsの標準のコマンドプロンプトと同じ見た目になりますが、文字の色分けが無かったりと少し扱いにくさがあると思います。)
次にgit pullの挙動を選択します。こちらは他人の修正内容を自分のPCに取り込む際の挙動を決めるのですが、初心者の私は一般的な挙動の一番上を選択しておきます。
次にCreditional Helperの設定です。途中で途切れてしまっており、詳細が分からないですが一番上を選ぶとWindowsの資格マネージャーがPWなどを覚えてくれるのでパスワード의入力の手間を省けるみたいです。
最後にOption設定を行います。一番上のファイルシステムのキャッシュのみチェックを付けます。(これにチェックをすることでファイルの読み書きにキャッシュをして高速化するみたいです。)
Enable symbolic linksはLinuxで使われるSymbolic Link機能をWindows上で再現できるみたいですが、私が使い方をよくわかっていないのと、チェックを付けている人が少なさそうなので今回はチェックを付けませんでした。
最後にインストールボタンを押下してインストールが終わり次第作業は終了です。もし、Release Notesが見たければこのままで Finishを押下して終了です。特に何も見たくなければ何もチェックせずにFinishを押下します。
SSH接続をするための設定を行う
Re:Viewを使うためにgitでCloneをしようとしたところSSH接続に失敗して接続ができませんでした。GitHubにアクセスするためにはssh-keyが必要になるのですが、何も設定していないことが原因です。ここではSSH接続巣をする際の初回セッティングを実施していきます。
gitをインストールする際にインストールしたgit bashを起動し、下記コマンドを入力します。
ssh-keygen -t ed25519このコマンドを入力すると下記のようなメッセージが出てきます。
Generating public/private ed25519 key pair.
Enter file in which to save the key (/c/Users/*****/.ssh/id_ed25519):こちらは簡単に言うと公開鍵と秘密鍵のペアをed25519という方式で作成します。どこに保存しますか？という内容です。
基本的にデフォルトの状態で問題はないのでこのままEnterを押下します。そうすると下記のようなメッセージが出てきます。
Enter passphrase for "/c/Users/****/.ssh/id_ed25519" (empty for no passphrase):これは作成するカギペアにパスワードを掛けるかどうかを確認されてます。パスワードを掛けると毎回パスワードを打ち込む手間がかかるのと、秘密鍵は私のPCのローカルにしかなく、秘密鍵が漏洩しない限りは問題ないため今回はパスワードは設定せず(何も入力しないでEnter)としました。Enterを押下すると同じパスフレーズを再度入力してくださいというメッセージが出てきますが、今回は空白なので再度Enterを押下します。
成功するとアスキーアートで鍵のイメージが表示されます。(これは公開していいものかわからなかったためここでは書きません。)
次に作成した公開鍵をGitHubに登録します。まずは下記ページに行きます。GitHubのアカウントがない人はアカウントの登録を行ってください。
https://github.com/settings/keys
New SSH keyを押下します。
タイトルは後で自分が分かれば問題なしで今回はMy Windows PCという風にしました。Key Typeはデフォルトのままです。
上記のKeyのところには先ほど生成した公開鍵を入力します。鍵はGitBushで下記コマンドを入力するとみることが出来ます。
cat ~/.ssh/id_ed25519.pubこれを入力することで公開鍵が表示されます。ssh-ed25519 "今回生成した公開鍵" PC名のような文字列が出力されると思うので、ssh-ed25519からPC名までの文字列をコピペして先ほどのKeyのところに貼り付けます。
これで設定は完了です。
まとめ
今回Gitをインストールしました。意外といろいろな設定をする必要があり、Geminiなどで調べながらやっていたら意外と時間がかかってしまいました。これでRe:Viewを使うためのセットアップが一通り終わったと思います。
.png)
0 件のコメント:
コメントを投稿