👨‍❤️‍💋‍👨

すぐ業務に就けるようにGitHubで一人チーム開発を体験してみた。

2021/07/06に公開約13,200字

最初に

最近になってようやくgithubでrepositorieを作成して、書いたコードをpushする事が習慣的に出来るようになって前よりも草が生やせるようになったので、今回はそれを記事にして残して置こうと思います。
それで業務にもすぐに対応出来るように今回は後半で、実際に自分が開発してる技術ブログに機能を追加する過程をチーム開発風にissueを立て、プルリクエストを出してマージするところまでやってみようと思う。

その前に基礎的なGit・GitHubの使い方を見ていこうと思う。

※ ブランチ名に master, main と混じって登場しますが、どちらも意味は同じです。 main ブランチを昔 master ブランチと呼んでいたので今はなるべく main ブランチという名前を使用する流れです。自分の開発環境が古く master をまだ使っている場合があります。

Clone

今回は初めて大学の卒業制作で作成した検索エンジンをGithubに上げていたのでそれをcloneしてみる。

ディレクトリを作成する。

そこに移動する。

mkdir searchEngine
cd searchEngine

cloneする。URLはGithubのレポジトリページにあるcodeをクリックするとclone用のページを表示してくれます。

git clone https://github.com/wimpykid719/pythonengine.git

cloneすると移動したディレクトリにファイルがダウンロードされる。そして開発を始めていく流れだと思う。

コードをGithubにあげるまで

リモートリポジトリはあらかじめGithubのサイトで作成しておく。

Githubで管理したいコードが置いてあるフォルダ内で実行する。

git init

.gitというフォルダ作成される。

次にファイルをステージングエリアに移動させる。

git add .
git commit -m "メッセージ"

※直前の git add を取り消したい場合は git reset HEAD を使うと取り消す事ができる。

※コミットメッセージのみ修正したい場合は下記を実行する。

git commit --amend -m "修正後コメント"

さらにコミット自体を取り消したい場合は下記のコマンドを実行するとコミットをなかった事にできる。

git reset --hard HEAD^

※gitをインストールして、はじめて使用する場合はユーザを入力してないと commit 出来ない。

ユーザ入力

新しくパソコンを買い替えた際もgitで下記の設定をしておかないと、commitした際にユーザが違う人になってGitHubのアカウントに草が生えなくなる。

git config --global user.name “userName”
git config --global user.email "xxx@yyy.com"

リモートリポジトリを指定する。

はじめてpushする際はアップロード先を指定する必要がある。

アップロード先はレポジトリ作成時のhttpsをコピペする。

git remote add origin アップロード先

これでGithubのリポジトリにコードが追加される。

git push -u origin master

# **ブランチ名がmasterでなく長い場合
#** 下記のようにすると現在のブランチの先頭、コミットの一番新しいものを指すことが出来る。
****git push origin HEAD

pushのオプション -u--set-upstream と同じ意味でこれを付けると次回から git push だけでGithubにコードをあげることが出来る。

ローカルブランチが上流ブランチorigin masterとして設定される。

イメージはGithubのレポジトリと直接繋がっているような感じ?そのため git push だけでGithubまでコードがアップされる。

上流ブランチとは

あるローカルブランチが履歴を追跡するように設定したリモートブランチの事を指す。

ローカルブランチが更新されたら、リモートブランチも更新される関係になる。

現在のブランチが上流ブランチに設定されているか確認

git branch -a

#実行結果
* master
  remotes/origin/master

* これは現在作業しているブランチを指している。その下に設定された上流ブランチが表示される。

間違えてアップしたファイルを.gitignoreで削除する方法

.gitignore というファイルを作成してそこにファイル名を書いて置けばいいんだけど、後からやる場合はキャッシュを削除する作業が必要みたい。

これを行なった後にadd とcommitしないと意味がない。

git rm --cached 無視したいファイル名

git rm -r --cached . これはファイル全体のキャッシュ削除

--cached オプションを使用しないと、ファイル事体が削除されるので注意が必要です。

ブランチの作成

新規機能の作成等でmainブランチからブランチを切って開発を進める事がある。その方法を紹介する。

現在のブランチを確認する。 * が付いているのが現在いるブランチ、下記の場合は main ブランチにいる。

git branch

#実行結果
* main
  settings-feedly-button

ブランチを実際に作成する。

git branch 作成したいブランチ名

作成したブランチに切り替える。

git checkout 作成したブランチ名

git バージョン2.23.0以降では switchcheckout と同じ事ができる。

オブション -c を使えばブランチの作成と切り替えを同時に行える。

git switch -c 作成して切り替えたいブランチ名

作成したブランチをGitHubにPushする

現在のブランチを切り替えたら

git push origin HEAD

これで現在のブランチをGitHubにpushする事が出来ます。

もしくはブランチ名を直接指定することも出来ます。

git push origin ブランチ名

作成したブランチをmainブランチにマージする

機能追加が終了し本番環境にデプロイする際にブランチをmainブランチにマージする事があります。

まずはメインのブランチに移動する。

git checkout メインのブランチ大体mainかmasterになってる。

その後でマージする事が出来ます。ただチーム開発ではプルリクエストを出してコードをレビューしてもらった後にGitHub上でマージする事が多いと思われるので、この操作を行うことは少ないかもしれない、

git merge マージしたいブランチ名

GitHubにマージした事を反映させる場合はブランチをmain, masterの状態で下記のコマンドを実行するとGitHub上でもマージが反映される。

git push

マージしたブランチを削除する

マージして不要になった、ブランチはなるべく消した方が良いので削除方法も載せておく。これでローカルのブランチは消せる。

GitHub上でブランチを削除した後にローカルのブランチを削除する方法

実はこの状態でブランチを削除してGitHubにpushしてもGitHub側のブランチは削除されない。削除するには手動でGitHub上で削除する必要がる。

git branch -d ブランチ名

リモートブランチを削除してから、それをローカルに反映させる方法

ローカルからコマンドを使用してGitHub上(リモートブランチ)を削除する。

git push --delete origin ブランチ名

リモートリポジトリのブランチ状態をローカルに同期する。

GitHub上でリモートブランチを先に削除した場合は下記のコマンドが使用で出来ます。これでローカルブランチも削除される事になる。

これは間違いで実際に削除するのは追跡ブランチでローカルブランチは削除されない。そのため git branch -d ブランチ名 を実行する必要がある。

他の記事とかにはよくこれで削除するみたいに書いてあったが、違うみたいだ。

それとも git push --delete origin ブランチ名 と実行したあとだとローカルにある追跡ブランチも同時に削除されるから、 git fetch -p リモートからローカルにデータを同期する際に追跡ブランチを通さないといけないが、それが存在しないため同期されないんだろうか? 試しにGitHubから手動でブランチを削除した後に git pull --prune をやってみたが、結果は同じでローカルブランチが削除される事はなかった。

詳しい方がいたら教えて下さい。

git fetch -p

実際に技術ブログに機能を追加しながら、チーム開発を行ってみる。

今回は技術ブログに機能追加を行う過程を、チーム開発風に行ってみたいと思う。機能としてはRSSを生成する機能を追加したらビルドに時間が掛かるようになってしまったため、本番環境以外ではRSSを生成する機能を実行しないようにする。

GitHubリポジトリにissueを立てる

タスクを設定しておいて、終わったらチェックを打って行くようにすると進捗が分かる。 - [ ] タスク でチェックボックスを追加出来る。

機能追加issue

機能追加用のブランチを切る

今回は make-rss-do-only-production というブランチを作成して、機能を実装していく。

git branch make-rss-do-only-production

ブランチを切り替える。

git checkout make-rss-do-only-production

機能開発を終えたらコミットする。

git add .
git commit -m "done rss do only production env"

リモートのリポジトリに作成したブランチをpushする。

git push origin HEAD

Pull リクエスト作成する

pullreq

GitHubに戻ると Compare & pull request とブランチが追加された等の表示がされるので、プルリクエストを作成する。

createpullreq

Closes #5 とする事でissueと結びつける事が出来、pull requestがマージされた際にissueを閉じる事ができる。 #5 は先ほど作成した issueの番号になる。

プルリクエストをマージする

ここからはチームリーダがプルリクエストされたコードをレビューして動作確認が取れたらマージする作業を行います。今回はいないので自分でマージしていきます。

Merge request をクリックするとマージされます。その前にコメントとか残しておくといいかもしれないです。

merge

マージが完了するとissueも自動でcloseされる。

merged

マージをローカルのリポジトリにも適用する

mainブランチ切り替えて、まだマージされていないブランチを確認する。まだローカルでは make-rss-do-only-production をマージしていないので make-rss-do-only-production が表示される。

git checkout main
git branch --no-merged

リモートリポジトリから最新のmainブランチを同期させる。

※ここでブランチをmainに切り替えてないと、マージされないので注意が必要です。

git pull origin main

その後 git branch --no-merged しても rss-do-only-production が表示されないのでローカルのブランチがマージされた事が確認できる。

リモートのブランチを削除する

git push --delete origin make-rss-do-only-production

ローカルのブランチを削除する

ここではまだローカルブランチが残っているので、 git fetch -p する事でリモートブランチとローカルブランチを同期する。と思っていたが、どうやらこれで削除するのは追跡ブランチというものらしい。

追跡ブランチとは

ローカルブランチとリモートブランチの間に噛ませるように追跡ブランチと上流ブランチが実はあるみたい。どうしてデータを同期する中継するような構造になってるかは分からない。この追跡ブランチが上流ブランチを通して、リモートブランチの変更を監視している。なのでここが削除されればリモートブランチの状態を反映するのは難しくなる。

ローカルブランチ(ローカル) → 追跡ブランチ(ローカル) → 上流ブランチ(リモート)→ リモートブランチ(リモート)

【Git】トラッキングブランチの存在を意識して理解を深める

ローカルブランチを削除するには手動での削除が必要になるので下記のコマンドで削除する。

git branch -d make-rss-do-only-production

これを繰り返しながらプロダクトを作っていく流れだと思う。

会社からパソコンが支給されてgit cloneして作業を始めたい時

とりあえずリポジトリをcloneする。

git clone リポジトリのHTTPS

ブランチも取り込みたい

これは自分が develop ブランチで途中まで作成してた関数の箇所もコードに反映させたいと思ったからである。

まずローカルでブランチを作成する。そこにリモートのブランチをマージする。

git branch develop
git checkout develop

リモートブランチの一覧を確認すると develop ブランチが見当たらない事が分かる。これはリモートブランチにまだdevelopが追加されていないためである。

git branch -r
# 下記のコマンドでリモートブランチを同期する。
git fetch --prune

そして下記のコマンドでpullする事でローカルにブランチをマージする事ができる。その際vim操作による、コミットメッセージも必要になる。

git pull origin develop

仮にmainブランチにある README.md だけに変更を加えてpushしたいときはブランチをmainに切り替えて、 git add README.md してステージングエリアにあげて git commit -m "fix:README.md" して git push でmainブランチに反映できる developブランチをマージする際に2つREADME.mdの変更箇所が被ってなければコンフリクトせずにマージされるはず。

masterの更新を取り込みたい

チームで開発してる途中でmasterが他のメンバーによって更新される中、自分が開発ブランチを切ったタイミングのmatserが古くなってしまった。なのでその更新された分を開発ブランチに取り込んで更新したい。


# まずmasterブランチを最新に更新する。
git pull --rebase origin master

# 次に開発ブランチに切り替える。
git checkout fix/****

# 開発ブランチにmasterの更新を取り込む。
# コンフリクトした場合はmasterの変更を優先する。
git merge master

rebaseとは

mergerebaseの違いは
どちらもブランチ元に統合する機能であるので、少しややこしい。そしてrebase自体はコミットログを操作するもので別途でmergeをする必要があるがgitが自動でmergeまでしてくれるのでコマンドを実行する必要はない。

なのでrebaseで作成されたコミットログとmergeで作成されたコミットログを比較してみようと思う。

merge
開発ブランチを切ってそれをmasterにmergeする流れ

コミットログは時間軸に沿って作成されている。

$ git log
commit 4700687982a4326a871a30253c61e4a3d1f1d2b8 (HEAD -> master)
Merge: bbe0ddb aceedcb
Author: “大学生だった <メールアドレス>
Date:   Fri Dec 31 10:39:26 2021 +0900

    コンフリクト解消

commit bbe0ddb64dd072bdc7c4597de726288f9e73be13
Author: “大学生だった <メールアドレス>
Date:   Fri Dec 31 10:36:59 2021 +0900

    masterをブランチ切った後に更新

commit aceedcb1408b52ba1f0c8c2947dbb2ac9f78cd3f (issue2)
Author: “大学生だった <メールアドレス>
Date:   Fri Dec 31 10:35:58 2021 +0900

    映画行こを追加

commit b0d23b51f9454386fa19f94b04a8cd58cba8846a
Author: “大学生だった <メールアドレス>
Date:   Fri Dec 31 10:35:11 2021 +0900

    どこ行くを追加

commit e7d02cbb46cbb6ae8e7239414d251fb61f869140
Author: “大学生だった <メールアドレス>
Date:   Fri Dec 31 10:32:12 2021 +0900

    最初のコミット 

rebase
開発ブランチを切ってそれをmasterにrebasesする流れ、コミットログの さらに更新 が開発ブランチを切った後に更新されたmasterの物である。こちらは時間軸には沿っておらず現在の最新masterの上に開発ブランチのログを引っ付けている感じになる。良い例えで枝(開発ブランチ)を切ってそのまま太い幹(masterブランチ)に引っ付けるという表現があった。
コミットログが綺麗になると言われるのはrebaseを使ってコミットログを作成しておくとmasterのコミットログと開発ブランチのコミットログが混じらないので変更を追いやすくなる。
mergeの場合は時間軸に沿ってなのでmasterでのコミットログと開発でのコミットログが混じってしまう。
これがチーム開発などになるとコミットログがカオスになるのは容易に想像できる。

rebaseの最中にコンフリクトが起きたら修正して git add 修正ファイル をして git rebase --continue を実行する。

$ git log
commit 0fba74cbea1a3b1df0b52fbb6e5ae52eee9cc45d (HEAD -> master)
Author: “大学生だった <メールアドレス>
Date:   Fri Dec 31 12:27:33 2021 +0900

    リベース後のマスター更新

commit 2568fc3e059db668488ea0dbccf90315ee614ec8 (issue2)
Author: “大学生だった <メールアドレス>
Date:   Fri Dec 31 10:56:32 2021 +0900

    僕最強だから

commit bb4c3db9378f3b2f028b448d54c13fc220c605ee
Author: “大学生だった <メールアドレス>
Date:   Fri Dec 31 10:55:59 2021 +0900

    大丈夫

commit fca3167ccb183887a5c1935ecc65c4e2f72b9f66
Author: “大学生だった <メールアドレス>
Date:   Fri Dec 31 10:58:40 2021 +0900

    さらに更新

commit e675f70201d85bf0fb131e900b34a65ca6ed4e45
Author: “大学生だった <メールアドレス>
Date:   Fri Dec 31 10:55:04 2021 +0900

    最初のリベースコミット

なので git pull --rebase origin master はGithubで更新されたmasterの変更をローカルのmasterにそのまま上にコミットログを載せてマージするイメージになる。ただ自分の会社の開発環境だとローカルでmasterを直接更新する機会はないので rebase オプションを付けなくてもコミットログに影響はない気がする。

最後に

git・githubは最初よく分からなくて、コンフリクト起こしたり、あんまり触るのが好きではなかったです。

今はリポジトリを作成してコードを管理するくらいはそつなくこなせるようになったので、これからは積極的にGitHubにコード上げていこうと思います。コード書くのも大変なんですけど、、、

どの仕事もやることは多いですが、エンジニアは使えないといけないツールが多くてコード書くのも大変だし、ツールのコンセプトを理解して使い方を覚えるのも大変です。

それでもプログラムが完成した瞬間は何にも変えられないくらい楽しいですね。

そのためだけに難しい言語を覚えて、難しいツールを覚えて使っていこうと思います。

参照

Gitでremoteリポジトリから新規にbranchを持ってくる方法

ローカルブランチに特定のリモートブランチをpull

git pushのオプション -u とは - Qiita

Git用語:上流ブランチとは?

git push -u オプションで"上流ブランチ"を設定

git push origin HEADを知らない人は時間を無駄にしています! - Qiita

gitコマンド checkoutとswitchの違い ~これからはswitchを使おう~ | Snow System

git add を取り消す - Qiita

gitを使用したブランチ作成からpushまでの簡単な流れ - Qiita

git mergeを使ってブランチをマージする方法 | TechAcademyマガジン

git fetch origin --prune doesn't delete local branches?

git remote prune origin does not delete the local branch even if its upstream remote branch is deleted

はじめてのPull Requestをやってみよう

開発者のタスク管理がしやすくなるGitHub Issuesの基本的な使い方

【1次試験】fwywd 採用試験

Milestone, Issue, Pull Requestを関連付けて扱う

[Git]コミットの取り消し、打ち消し、上書き

git mergeとrebaseの違い。ブランチを統合する方法。

git rebaseでのブランチ融合でコンフリクト解消

多少説明が間違えてる気がする。特にrebaseとmergeのメリットデメリットの説明でmergeはコミットログが消えるという表現があったがどちらを選択しても無くなる事はないと思う。
3分で理解できる!git-rebaseとmergeとの違いまとめ

git pull --rebaseをpushする前にやろうという話。

一応読んだ

HEADについて知りたくて読んだが、よく分からなかった。ブランチ、コミットについて詳しく書かれていた。

GitのHEADとは何者なのか - Qiita

記事に関するコメント等は

🕊:Twitter
📺:Youtube
📸:Instagram
👨🏻‍💻:Github
😥:Stackoverflow

でも受け付けています。どこかにはいます。

Discussion

ログインするとコメントできます