index.md

社内Git勉強会

勉強会のゴール

• 基本的なgitの操作に慣れる
• 実際に文言修正pull requestを投げられるようにする

TODO: 井上くんに「なんすか？めんどくさいっす自分で直してください」って言われなくなるみたいないらすと屋の画像を作る

対象者

• ソフトウェア開発のPM
• 駆け出しエンジニア

必要なもの

• VSCode

コマンドラインでやりたい人は terminal に git を入れてください。

今一番ポピュラーなテキストエディタは vim VSCode なので入れとけばいいと思います。

他のGitクライアント使っても同じことができます。

• SourceTree
• GitHub Desktop
• Git Kraken

今回はVSCodeのGitの機能を使おうと思います。

そもそもGitってなんなの？

難しく言うと、分散型レポジトリシステム。

簡単に言うと、複数人でできるバージョン管理システム。

抑えとくべき用語/コマンド

最低限これさえあればなんとかなる。

用語

1. リモートレポジトリ ... GitHubなどオンライン上に中央集権的にコードや変更履歴を貯めるところ
2. ローカルレポジトリ ... 自分のPC上でコードや変更履歴をためているところ
3. ブランチ ... 個人の作業やリリースを分割するために独立させたコードの集合。ブランチ同士は(基本的に)関連している。
4. チェックアウト ... ブランチの切り替え操作のこと

基本

1. git clone ... レポジトリをローカルにダウンロードしてくる
2. git status ... 自分が変更したファイルが見れる
3. git add ... 自分が変更したファイルを
4. git commit ... add で選択したファイルにコメントを付けて保存
5. git push ... ローカルにある最新の情報をGitHubにアップロードする
6. git pull ... GitHub上にあるレポジトリの最新の情報を取ってくる

ブランチ操作

1. git branch ... ブランチの操作をする
2. git checkout ... ブランチを切り替える

gitコマンドを入れて、ssh keyをGitHubに登録する

コマンドの導入

$ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
$ brew install git
$ git --version
git version 2.25.0

ssh keyを作成する

~/.ssh = ssh関連のファイルを入れるディレクトリ ないかもしれないのでmkdirコマンドで作成する

$ mkdir ~/.ssh
$ cd ~/.ssh

ssh_keygen = ssh keyを生成するコマンド tomimori_sとかtomimori_s@uuum.jpは自分のものに変更

$ ssh-keygen -t rsa -b 4096 -C "tomimori_s@uuum.jp" -f tomimori_s

コマンドを叩いた後にパスフレーズを2回聞かれるので入力します(画面には入力している内容は出ない) パスフレーズは空でもOK

$ ls -la
-rw-------   1 tousa_k  staff  3381  2  7 11:47 tomimori_s
-rw-r--r--   1 tousa_k  staff   744  2  7 11:47 tomimori_s.pub

ssh-keygenコマンドを叩いた直後。パスフレーズ1回目を聞かれる。

もう一度同じパスフレーズを入力。

ssh keyが作られたところ。

lsコマンドで中身を確認してtomimori_sとtomimori_s.pubができていればOK

作成したssh keyをGitHubに登録する

GitHub右上のメニューからSettingsを選択

SSH and GPG keysを選択

New SSH Keyを選択

ここで一度ターミナルに戻って、コマンドを叩く。 ※tomimori_sではなく、tomimori_s.pubであることに注意

$ cat ~/.ssh/tomimori_s.pub | pbcopy

GitHubに戻って貼り付けてからAdd SSH KEYをクリック。タイトルは空でもOK。

元の画面に戻って、画像のように追加されていればOK。

GitHubと通信できるか確認する

ssh通信する設定を書いたconfigファイルを落としてくる

$ curl https://raw.githubusercontent.com/UUUM/git-study/master/config.sample > ~/.ssh/config

自分が作ったssh keyの名前でファイルの中身を置換する(okubo_mが自分のものになる)

$ sed -i -e 's/tomimori_s/okubo_m/' ~/.ssh/config

sshコマンドでGitHubにつなげられるかチェックする パスフレーズを聞かれるのでssh keyを作ったときと同じものを入れる。

$ ssh -T github.com
Enter passphrase for key '/Users/XXX/.ssh/okubo_m':
Hi MozyOk! You've successfully authenticated, but GitHub does not provide shell access.

まずはレポジトリをcloneする

このレポジトリ をクローンする

$ cd ~/Desktop
$ git clone git@github.com:UUUM/git-study.git
$ cd git-study

VSCodeでクローンした UUUM/git-study を開いてみる。

issueを立ててみる

url: https://github.com/UUUM/git-study/issues

先に立ててみた

branchを切ってみる

VSCodeの場合

コマンドラインでやる場合

# 01.mdを更新したい場合
$ git branch
* master
$ git checkout -b feature/update-01_md
Switched to a new branch 'feature/update-01_md'
$ git br
* feature/update-01_md
  master

作業をする

issueで割り当てられたファイルを適当に編集してみる。

commitしてpushをする

VSCodeの場合

コマンドラインでやる場合

01.md のファイルを編集した場合こういう表示になる

$ git status
On branch master
Your branch is ahead of 'origin/master' by 1 commit.
  (use "git push" to publish your local commits)

Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
    modified:   01.md

no changes added to commit (use "git add" and/or "git commit -a")


$ git add 01.md
$ git commit -m "ここにコミットメッセージを書く"
$ git push origin HEAD

pull requestを作り、mergeしてみる

masterを最新にする

VSCodeの場合

コマンドラインでやるなら

$ git branch
* feature/add-01
  master
$ git checkout maser
$ git pull

参考記事

• GitHubで共同開発のためのチュートリアル
• サルでもわかるGit入門